Documentation

**Template documentation** (for the above template, sometimes hidden or invisible)

## Description

This template is used to insert descriptions on template pages.

## Syntax

Add `<noinclude>{{Documentation}}</noinclude>` at the end of the template page.

Add `<noinclude>{{Documentation|*<documentation page>*}}</noinclude>` to transclude an alternative page from the /doc subpage.

## Usage

### On the Template page

This is the normal format when used:

```
TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>

```

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

*A line break right before `{{Documentation}}` 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 <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>

```

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

Visit Template:Documentation/doc to edit this text! (How does this work?)

 Editors can experiment in this template's sandbox and test case pages.

## Description

This template is used to insert descriptions on template pages.

## Syntax

Add `<noinclude>{{Documentation}}</noinclude>` at the end of the template page.

Add `<noinclude>{{Documentation|*<documentation page>*}}</noinclude>` to transclude an alternative page from the /doc subpage.

## Usage

### On the Template page

This is the normal format when used:

```
TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>

```

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

*A line break right before `{{Documentation}}` 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 <code>{{t|templatename}}</code> somewhere.

==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>

```

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