Template:Documentation: Difference between revisions
imported>Pathoschild m (Protected Template:Documentation: High-use template [edit=autoconfirmed:move=autoconfirmed]) |
imported>CBM (add CSS class "template-documentation". Otherwise nobody can turn off the silly background color) |
||
| Line 1: | Line 1: | ||
<includeonly><div style="padding:5px; background:#ECFCF4; border:1px solid #AAA; clear:both;" class="plainlinks"><div style="border-bottom:1px solid #AAA; margin-bottom:0.5em;"><span class="editsection"><nowiki>[</nowiki>[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]] [[{{fullurl:{{{1|{{SUBJECTPAGENAMEE}}/doc}}}|action=edit}} edit]]</span><big>'''{{SUBJECTSPACE}} documentation'''</big></div>{{{{SUBJECTPAGENAME}}/doc}}</div></includeonly><noinclude> | <includeonly><div style="padding:5px; background:#ECFCF4; border:1px solid #AAA; clear:both;" class="plainlinks template-documentation"><div style="border-bottom:1px solid #AAA; margin-bottom:0.5em;"><span class="editsection"><nowiki>[</nowiki>[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]] [[{{fullurl:{{{1|{{SUBJECTPAGENAMEE}}/doc}}}|action=edit}} edit]]</span><big>'''{{SUBJECTSPACE}} documentation'''</big></div>{{{{SUBJECTPAGENAME}}/doc}}</div></includeonly><noinclude> | ||
{{documentation}}</noinclude> | {{documentation}}</noinclude> | ||
Revision as of 17:33, 2 October 2007
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>{{documentation}}</noinclude> at the end of the template page.
Add <noinclude>{{documentation|<documentation page>}}</noinclude> to transclude an alternative page from the /doc subpage.
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 documentation page
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).
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.