Template:Documentation/doc: Difference between revisions
sims>K6ka (Created page with " ==Description== This template is used to insert descriptions on template pages. ==Syntax== Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></now...") |
sims>K6ka No edit summary |
||
| Line 13: | Line 13: | ||
<pre> |
<pre> |
||
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> |
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> |
||
{{documentation}} |
{{documentation}} |
||
Any categories for the template itself</noinclude> |
|||
</pre> |
</pre> |
||
| Line 37: | Line 38: | ||
{{templatename|input}} |
{{templatename|input}} |
||
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
|||
</pre> |
</pre> |
||
| Line 43: | Line 44: | ||
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. |
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates. |
||
==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> |
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
||
Revision as of 14:16, 13 May 2017
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}
Any categories for the template itself</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} 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:
==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}}
<noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
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.
Credits
This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.