Template:Documentation
- Please copy {{Documentation}}'s preload template from w:c:templates:Template:Documentation/preload to Template:Documentation/preload!
- Please copy {{T}}'s documentation from w:c:templates:Template:T/doc to Template:T/doc!
Description
- Note: This template requires the variables extension. See Help:Extensions on Community Central for information on how to request this.
This template is used to insert template information, its parameters, and other information on a template page. More information may be found at Help:Template documentation on Community Central.
Syntax
Add <noinclude> at the end of the template page.
{{Documentation}}</noinclude>
Add <noinclude> to transclude an alternative page from the /doc subpage.
{{Documentation|</noinclude><documentation page>}}
To add documentation inline, meaning on the main template page itself, add <noinclude>
{{Documentation|</noinclude>content=custom inline content}}
For full syntax, see #Advanced syntax.
Basic 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>
Some notes:
- 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. - If for some reason you need to transclude a different page other than the documentation page (e.g. when using a group of templates with same documentation), you can use the
|1=parameter (see Syntax). - If the template documentation is rather short, you can specify documentation inline with the text, by using the
|content=parameter (see Syntax again).
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|param1}}</code> somewhere.
=== Parameters ===
;<code>param1</code>
: This parameter is used to add something.
=== TemplateData ===
<templatedata>{}</templatedata>
== Examples ==
<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.
Advanced syntax
This template is used to insert a description of a template.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Custom page to transclude | 1 | A custom page to transclude, usually another documentation page | Page name | optional |
| Custom content | content | Custom inline content to add in the template. When this is added, the template does not transclude 1= or the /doc subpage | String | optional |
| Demo page | page | For testing purposes | Page name | optional |
| Demo namespace | demospace | For testing purposes; changes the internal namespace of the template | String | optional |
| Custom documentation preload | preload | Custom documentation preload that will be used for the [create] links for the /doc subpage | Page name | optional |
| Custom preload page for /sandbox subpage | preload-sandbox | no description | Page name | optional |
| Custom preload page for /testcases subpage | preload-testcases | no description | Page name | optional |
| Custom /sandbox subpage | sandbox | Page that is used for the /sandbox link | Page name | optional |
| Custom /testcases page | testcases | Page that is used for the /testcases link | Page name | optional |
| Custom heading text | heading | no description | String | optional |
| Disable footer | nofooter | Disables the footer or "link box" located below the documentation content. | Boolean | optional |
