Template:Documentation/doc

Description

This template is used to insert descriptions on template pages.

Syntax

Type <noinclude>{{documentation}}</noinclude> at the top of the template page or <onlyinclude>Template code</onlyinclude>{{documentation}}.

See also

• {{Documentation2}} - for documenting template-like page in the main namespace.

General usage

On the Template page

<noinclude>{{documentation}}
</noinclude>Template code
<includeonly>Categories applied to pages using the template</includeonly>

The line break before <includeonly> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <includeonly> to immediately after </noinclude>, hiding the template from view.

OR

{{documentation}}
<onlyinclude>Template code</onlyinclude>
<includeonly>Categories applied to pages using the template</includeonly>

On the Template/doc page

;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code>&lt;nowiki&gt;{{templatename|foo}}&lt;/nowiki&gt;</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.

Non-Template namespace usage

On the Template page

<noinclude>{{documentation|ns=User}}
</noinclude>Template code
<includeonly>Categories applied to pages using the template</includeonly>

The line break before <includeonly> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <includeonly> to immediately after <noinclude>, hiding the template from view.