Template:Documentation: Difference between revisions
From Growtopia
Jump to navigationJump to search
>26nightmare m Protected "Template:Documentation": Explaintion ([edit=sysop] (indefinite) [move=sysop] (indefinite)) |
>NekoPillow mNo edit summary |
||
| Line 1: | Line 1: | ||
<includeonly>{| class="article-table" style="width:100%;" | <includeonly>{| class="article-table" style="width:100%;" | ||
|- style="font-size:18px;" | |- style="font-size:18px;" | ||
! Template | ! Template Documentation | ||
|- | |- | ||
| | | Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) | ||
|- | |- | ||
| | | [[{{fullurl:{{FULLPAGENAME}}|action=edit}} Edit]] [[{{fullurl:{{FULLPAGENAME}}|action=history}} History]] [[{{fullurl:{{FULLPAGENAME}}|action=purge}} Purge]] | ||
|} | |} | ||
<div style="margin:0 1em;"> | <div style="margin:0 1em;"> | ||
{{tocright}} | {{tocright}} | ||
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> | {{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> | ||
Revision as of 17:03, 4 September 2017
| Template Documentation |
|---|
| Visit Template:Documentation/doc to edit this documentation. (How does this work?) |
| [Edit] [History] [Purge] |
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}}</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}}
<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.
