Template:Documentation

Template Documentation follows
[view | edit | history | purge]

Description

This template is used to insert documentation on template pages.

Syntax

Type <noinclude>{{Documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

Template code<noinclude>
{{Documentation}}
</noinclude>

On the Template/doc page

; Description
: This template is used to do something.
; Dependencies:
:* Uses (some CSS, JS, file, or other template).
; Syntax
: Type <code>{{T|Templatename}}</code> somewhere.
; Sample output
: <code><nowiki>{{Templatename|foo}}</nowiki></code> gives...
: {{Templatename|foo}}

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

Note that the above example also uses {{T}}.

Dependencies

Templates

Template:Tocright (Template:Tocright/doc)

TemplateData

This template is used to display documentation on template pages. It also adds some tools to help the editor to modify the /doc subpage and the template.

Template parameters

Parameter		Description	Type	Status
Custom Documentation Location	1	The name of the custom /doc subpage. Default {{FULLPAGENAME}}/doc Example Template:Documentation/doc	String	optional
Inline Documentation Content	content	Content if documentation page will not be transcluded Example This template creates quotes.	String	optional
Custom Sandbox Location	sandbox	Specifies the /sandbox subpage location Default {{FULLPAGENAME}}/sandbox Example Template:Example/sandbox	String	optional
Heading text	heading	Changes the default "Documentation" header to a different one Example About this template	String	optional
Custom footer content	footer	Replaces the default link box with a custom one Example Documentation is automatically generated by {{T|Ambox}}. Its contents are shown here.	Unbalanced wikitext	optional

The above documentation is transcluded from Template:Documentation/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) page.
Add categories and interwikis to the /doc subpage. Subpages of this template.