Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit Template:Documentation/doc to edit this documentation. (How does this work?)


This template is used to insert descriptions on template pages.


Add <noinclude>{{documentation}}</noinclude> at the end of the template page.


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>

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:

This template is used to do something.

Type <code>{{t|templatename}}</code> somewhere.
:{|class="wikitable" style=""
! Slot !! Required? !! Default !! Usage !! Note
| Anonymous Param. 1 || Required/Optional || <code>default</code>/''empty''/''error'' || What this param for || Requirements, properties, or/and limitations 
| Anonymous Param. 2<br>abc || At least one || <code>inherit/black</code> || What these params for|| abc suppresses Anonymous Param. 2


results in...

[{{fullurl:{{FULLPAGENAME}}}}?action=purge Click here to refresh the preview above]
<includeonly>Any categories for the template itself</includeonly><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.
Community content is available under CC-BY-SA unless otherwise noted.