Template:Documentation/doc

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

Syntax
Add  at the end of the template page.

Add  to transclude an alternative page from the /doc subpage.

On the Template page
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 documentation page
The documentation page is usually located on the /doc subpage for a template, but a different page can be specified with the first parameter of the template (see Syntax).

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.

TemplateData
{	"params": { "1": {			"label": "Documentation page", "description": "Specifies the documentation page to be transcluded", "type": "wiki-page-name" }	},	"description": "Transcludes documentation for a template page. Should be enclosed by tags when used", "format": "inline" }