Editing Template:Documentation/doc

==Description==
This template is used to insert descriptions on template pages.

==Syntax==
* '''1:''' documentation page - optional alternative doc page instead of /doc
* '''type:'''  optional template type. Will add category in the form of <code><nowiki>[[Category:{type} templates]]</nowiki></code>.
* '''type2:''' optional template type. Will add category in the form of <code><nowiki>[[Category:{type2} templates]]</nowiki></code>.
* '''draft:''' set to 1 if this documentation is for a draft template

Add <code><nowiki><noinclude></nowiki>{{t|Documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.

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

==Usage==

===On the Template page===
This is the normal format when used:

<pre>
TEMPLATE CODE
<includeonly>Any categories to be inserted into articles by the template</includeonly>
<noinclude>{{Documentation}}</noinclude>
</pre>

''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{Documentation}}</nowiki></code> is inserted (within the noinclude tags).''

''A line break right before <code><nowiki>{{Documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''

===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|Syntax]]).

Normally, you will want to write something like the following on the documentation page:

<pre>
==Description==
This template is used to do something.

==Syntax==
Type <code>{{t|templatename}}</code> somewhere.

==Samples==
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code> 

results in...

{{templatename|input}}

<includeonly>Any categories for the template itself</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>
</pre>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.

Note that the above example also uses the [[Template:T]] template.

==Template Data==
<templatedata>
{
	"params": {
		"1": {
			"label": "Alternative doc page",
			"description": "Optional alternative page for documentation instead of Template:{name}/doc. Unless if there's a specific reason to not use the default doc page, you shouldn't use an alternative.",
			"type": "wiki-page-name"
		},
		"draft": {
			"label": "Is draft",
			"description": "Set to 1 if this is for a draft template.",
			"type": "boolean"
		},
		"type": {
			"label": "Type",
			"description": "Optional template type.. Do not include \"Templates\" suffix.",
			"example": "Infobox",
			"type": "string",
			"suggested": true
		},
		"type2": {
			"label": "Type 2",
			"description": "Optional template type. Do not include \"Templates\" suffix.",
			"example": "Infobox",
			"type": "string"
		}
	},
	"paramOrder": [
		"type",
		"type2",
		"draft",
		"1"
	],
	"description": "This template is used to insert descriptions on template pages."
}
</templatedata>
<includeonly>[[Category:Documentation Templates]]</includeonly><noinclude>[[Category:Template Documentation]]</noinclude>