Documentation (copy)

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>{{Documentation}}</noinclude> at the end of the template page.

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

To add documentation inline, meaning on the main template page itself, add <noinclude>{{Documentation|content=custom inline content}}</noinclude>

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[]

Dependencies[]

Templates

Template:Documentation/preload

Template:Documentation/preload-sandbox

Template:Documentation/preload-testcases

Images

File:Documentation_icon.svg

File:No_Documentation_icon.svg