Template:Documentation

From Modding Haven
Revision as of 22:43, 13 August 2023 by Admin (talk | contribs) (Created page with "<includeonly>{| class="article-table" style="width:100%;" |- style="font-size:18px;" ! Template documentation follows |- | ''Note: the template above may sometimes be partially or fully invisible.'' |- | Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. (How does this work?) |} <div style="margin:0 1em;"> {{tocright}} {{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}} </noincl...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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?)

Description[edit source]

This template is used to insert descriptions on template pages.

Syntax[edit source]

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

Usage[edit source]

On the Template page[edit source]

This is the normal format when used:

TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</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 source]

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

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