Template:Documentation/doc

Description
This template is used to insert descriptions on template pages.

Syntax
Add  at the end of the template page.

On the Template page
Template code Any categories to be inserted into articles by the template

Note that, depending on the template, you may need to add a clear or complete a table/div just before  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

 * Description
 * This template is used to do something.


 * Syntax
 * Type  somewhere.


 * Sample output
 * gives...

Any categories for the template itself

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.

This is the normal format when used:

TEMPLATE CODE Any categories to be inserted into articles by the template

If your template is not a completed div or table, you may need to close the tags just before  is inserted (within the noinclude tags).

A line break right before  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  somewhere.

Samples
results in...

Any categories for the template itself

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.