3,309
edits
Template:Documentation/doc: Difference between revisions
m
12 revisions imported: Import from https://sims.wikia.com
sims>Kirkburn mNo edit summary |
m (12 revisions imported: Import from https://sims.wikia.com) |
||
| (12 intermediate revisions by 6 users not shown) | |||
Line 1:
;Description▼
:This template is used to insert descriptions on template pages.▼
;Syntax▼
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.▼
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly>▼
▲
==Usage==
===On the Template page===
This is the normal format when used:
<pre>
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}
Any categories for the template itself</noinclude>
</pre>
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).''
''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''
===On the Template/doc page===
Normally, you will want to write something like the following on the documentation page:
<pre>
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
▲<
</pre>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
{{Important note|When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.}}
==Credits==
This template's code was taken from [[wikia:w:c:k6ka:Template:Documentation|Template:Documentation]] on K6ka's Wiki on Wikia.
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
| |||