Template:Documentation: Difference between revisions
sims>K6ka (Revert to revision 427110 dated 2012-09-06 13:38:49 by Nikel23 using popups) |
sims>K6ka m (K6ka moved page Template:Documentation to Template:Documentation/deleted revisions/Templates Wiki import fail: cleaning up page histories after LiR's messed up import) |
(No difference)
|
Revision as of 23:32, 14 December 2014
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.