(Moved this page to the title case category Template Documentation.)
(category fix)
Line 42: Line 42:
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.
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template Documentation|{{PAGENAME}}]]</noinclude>
<includeonly>[[Category:Templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 21:42, January 15, 2019

Description Edit

This template is used to insert descriptions on template pages.

Syntax Edit

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

Usage Edit

On the Template Page Edit

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 Edit

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 ===

results in...


<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.