Template:Documentation: Difference between revisions
sims>Woganhemlock m (Reverted edits by Ĺаncer1289 (talk | block) to last version by Roguebfl) |
sims>Random Ranaun No edit summary |
||
Line 1: | Line 1: | ||
<div style="clear: both; border: 1px solid black; margin: 1em; margin-top: 3em;"> |
<div style="clear: both; border: 1px solid black; margin: 1em; margin-top: 3em;"> |
||
<div style="background: #ddd; color: #111; padding: 1em; margin: 0em;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span></div> |
<div style="background: #ddd; color: #111; padding: 1em; margin: 0em;">'''Template documentation''' <span style="font-size: 85%;">(for the above template, sometimes hidden or invisible)</span></div> |
||
<div style="padding: 1em; padding-bottom: 0em; margin: 0em;">{{ |
<div style="background: #ffffff; padding: 1em; padding-bottom: 0em; margin: 0em;">{{ |
||
#ifexist: {{FULLPAGENAME}}/doc |
#ifexist: {{FULLPAGENAME}}/doc |
||
| {{tocright}}{{{{PAGENAME}}/doc}} |
| {{tocright}}{{{{PAGENAME}}/doc}} |
Revision as of 09:21, 20 July 2011
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}} Any categories for the template itself</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}} <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.
Credits
This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.