Template:Documentation/doc

Purpose

This template is used to insert descriptions on template pages.

Usage

On the Template page

<includeonly> Template code... Any categories to be inserted into articles by the template..</includeonly><noinclude> Template's categories.. {{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

== Purpose ==
This template is used to do something.

== Usage ==
<pre>{{templatename|template parameters}}</pr e>

== Parameters ==
{| class="wikitable"
! Parameter
! Explanation
|-
| firstparameter
| Description of the first parameter
|-
| ...
| ...
...
|}

== Example ==
<pre>{{templatename|template parameters}}</pr e>
{{templatename|template parameters}}

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

Parameters

Parameter	Explanation
1 (optional)	The name of template whose documentation will be displayed.

Example

{{documentation}}

{{documentation|Infobox Location}}