Template:Documentation

Instructions for {{Documentation}}

Description

This template is used to insert descriptions on template pages.

Syntax

Type <noinclude>Template:T</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>
{{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.

Alternately, you may find it better to consistently put {{documentation}} at the very end of your template, immediately next to the category in which the template is to be placed. Thus:

;<includeonly>template code
;more template code
;more template code
;more template code</includeonly>
;<noinclude>{{documentation}}[[Category:Templates]]</noinclude>

If your template is producing a few blank lines at the top, {{documentation}} is a likely cause. The above solution will remove those lines.

On the Template/doc page

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

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.

Visit the documentation page to edit this text! (How does this work?)