Documentation

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

Description

Template:Documentation is used to insert descriptions on template pages.

Syntax

<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>
{{documentation}}</noinclude>

 Note: Depending on the template, you may need to insert the {{clr}} template (or complete a table/div) just before inserting <noinclude>{{documentation}}</noinclude>.

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

On the Template/doc page

<noinclude>{{documentation subpage}}</noinclude>
=== Description ===

'''{{FULLPAGENAME}}''' is used to do something.

=== Syntax ===

 {{tlx|templatename}}

=== Parameters ===

;{{para|foo}} : purpose of foo

=== Examples ===

 {{tlx|templatename}}

;produces…

{{templatename}}


{{tlx|templatename|<var>foo</var>}}

;produces …

{{templatename|foo}}

=== See also ===


<includeonly>
Any categories for the template itself
</includeonly>

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.

 Note: The above example also uses Template:Tlx.

The above Template documentation is transcluded from Template:Documentation/doc. (edit | history)
Editors can experiment in this template’s sandbox (edit | diff) and testcases (edit) pages
Please add categories and interwikis to the /doc subpage.
Subpages of this template