Template:Doc

Template documentation [View] [Edit] [History] [Refresh]

Description

This template will float the article's table of contents to the right. It will also force a ToC when/where it would not normally be found.

Use it only when needed.

Syntax

Type {{tocright}}

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.