Difference between revisions of "Template:Documentation"
WikimanBot (talk | contribs) |
WikimanBot (talk | contribs) |
||
| Line 1: | Line 1: | ||
| − | <includeonly><div style="border:3px dashed #920;"> | + | <includeonly><div style="border:3px dashed #920; padding:0.5em 1em;">{{tocright}} |
<div style="font-size:18px; color:#920; text-align:center;">Template documentation follows</div> | <div style="font-size:18px; color:#920; text-align:center;">Template documentation follows</div> | ||
''Note: the template above may sometimes be partially or fully invisible.'' | ''Note: the template above may sometimes be partially or fully invisible.'' | ||
| Line 5: | Line 5: | ||
Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) | Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]]) | ||
| − | + | {{{{PAGENAME}}/doc}} | |
| − | + | {{clear}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude> | |
| − | {{{{PAGENAME}}/doc}} | ||
| − | |||
Revision as of 09:32, 17 November 2014
Note: the template above may sometimes be partially or fully invisible.
Visit Template:Documentation/doc to edit this documentation. (How does this work?)
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.