Template:Documentation/doc
Description
This template is used to insert descriptions on template pages.
Syntax
- 1: documentation page - optional alternative doc page instead of /doc
- type: optional template type. Will add category in the form of
[[Category:{type} templates]]. - type2: optional template type. Will add category in the form of
[[Category:{type2} templates]]. - draft: set to 1 if this documentation is for a draft template
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.
Template Data
This template is used to insert descriptions on template pages.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Type | type | Optional template type.. Do not include "Templates" suffix.
| String | suggested |
| Type 2 | type2 | Optional template type. Do not include "Templates" suffix.
| String | optional |
| Is draft | draft | Set to 1 if this is for a draft template. | Boolean | optional |
| Alternative doc page | 1 | Optional alternative page for documentation instead of Template:{name}/doc. Unless if there's a specific reason to not use the default doc page, you shouldn't use an alternative. | Page name | optional |