Template:Documentation

From Animated Muscle Women
Template documentation (for the above template, sometimes hidden or invisible)
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<noinclude>

Template:Protected template

Usage[edit source]

Prints the value passed to it.

This is a meta-template for use with complex template nesting tricks. See also Template:F.</noinclude>

Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>documentation<noinclude>

Template:Protected template

Usage[edit source]

Prints the value passed to it.

This is a meta-template for use with complex template nesting tricks. See also Template:F.</noinclude></noinclude> at the end of the template page.

General usage[edit source]

On the Template page[edit source]

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</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[edit source]

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

<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.


Template documentation (for the above template, sometimes hidden or invisible)
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<noinclude>

Template:Protected template

Usage[edit source]

Prints the value passed to it.

This is a meta-template for use with complex template nesting tricks. See also Template:F.</noinclude>

Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>documentation<noinclude>

Template:Protected template

Usage[edit source]

Prints the value passed to it.

This is a meta-template for use with complex template nesting tricks. See also Template:F.</noinclude></noinclude> at the end of the template page.

General usage[edit source]

On the Template page[edit source]

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</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[edit source]

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

<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.