Template:Documentation: Difference between revisions
From Graal Military Wiki
Content added Content deleted
(+ heading override) |
(remove border if no heading) |
||
Line 1: | Line 1: | ||
<div class="template-documentation"> |
<div class="template-documentation"> |
||
<div style="padding-bottom:3px; border-bottom:1px solid #aaa; margin-bottom:1ex;"> |
<div style="padding-bottom:3px; {{#if:{{{heading|defaultnotblank}}}||border-bottom:1px solid #aaa;}} margin-bottom:1ex;"> |
||
<span class="editsection plainlinks">[[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]] |
<span class="editsection plainlinks">[[[{{{1|{{SUBJECTPAGENAME}}/doc}}}|view]]] |
||
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]] |
[[{{fullurl:{{{1|{{SUBJECTPAGENAME}}/doc}}}|action=edit{{#ifexist: {{{1|{{SUBJECTSPACE}}:{{SUBJECTPAGENAME}}/doc}}} ||&preload=Template:Documentation/preload}}}} edit]] |
Revision as of 13:55, 18 October 2007
==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.