m (1 revision)
Line 1: Line 1:
<noinclude><div style="display:none;"></noinclude><div style="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="padding:1em; padding-bottom:0em; margin:0em;">{{tocright}}
<includeonly>{| class="article-table" style="width:100%;"
|- style="font-size:18px;"
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div>
! Template documentation follows
{{documentation}}[[Category:Template documentation| ]]</noinclude>
| ''Note: the template above may sometimes be partially or fully invisible.''
| Visit [[Template:{{PAGENAMEE}}/doc]] to edit this documentation. ([[Template:Documentation|How does this work?]])
<div style="margin:0 1em;">
{{{{PAGENAME}}/doc}}</div></includeonly><noinclude>{{documentation}}[[Category:Template documentation| ]]</noinclude>

Revision as of 09:28, March 26, 2013

You don't want this version of the documentation template on your wiki! Click here to revert it.

For a documentation template you can use on your wiki, see w:c:templates:Template:Documentation (copy).

Template documentation
Note: the template above may sometimes be partially or fully invisible.
View or edit this documentation. (How does this work?)
Editors can experiment with this template's sandbox and test case pages.
This template is used to insert descriptions on template pages.
Type <noinclude>{{documentation}}

</noinclude> at the end of the template page.

General usage

On the Template page

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

:This template is used to do something.
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...

<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 further usage information sections.

Note that the above example also uses the Template:T and Template:T/piece templates.

Community content is available under CC-BY-SA unless otherwise noted.