FANDOM


Template documentation
Note: parts of or entire template might not be visible without values provided.
Description
This template is used to insert descriptions on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{t|documentation}}</noinclude>

Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

For documentation i18n, see Project:Coding_conventions#Documentation i18n.
For translation guidance, see Project:I18n#Translation.

;{{#invoke:I18n|getMsg|Documentation|description}}
:This template is used to do something.
;{{#invoke:I18n|getMsg|Documentation|syntax}}
:Type {{t|for}} somewhere.
;{{#invoke:I18n|getMsg|Documentation|sample_output}}
:{{#invoke:I18n|getMsg|Documentation|sample_output-text|{{t|for|foo|Template:Documentation}}}}
: {{for|foo|Template:Documentation}}

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

gives...

Description
This template is used to do something.
Syntax
Type {{for}} somewhere.
Sample output
{{for|<foo>|<Template:Documentation>}} gives...
For foo, see Template:Documentation.

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 further usage information sections.

Dependencies

Translation

The template translations are stored at:
Text above can be found here (edit)
Community content is available under CC-BY-SA unless otherwise noted.

Fandom may earn an affiliate commission on sales made from links on this page.

Stream the best stories.

Fandom may earn an affiliate commission on sales made from links on this page.

Get Disney+