Template:Documentation/doc

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

Usage
Type  at the end of the template page.

On the Template page
Note that, depending on the template, you may need to add a clear or complete a table/div just before  is inserted. The line break is also useful as it helps prevent the documentation template "running into" previous code.

An alternative way to type documentation is using it inline, like:

On the Template/doc page
somewhere.
 * Large Documentation

Parameters

 * parameter
 * This parameter is abc

TemplateData
{ "params": { "parameter": {} } }

Examples
Any categories for the template itself somewhere.
 * Short templates

Type  for a.

{ "params": { "parameter": {} } }
 * TemplateData

gives:
 * Examples

Any categories for the template itself

TemplateData
{	"params": { "1": {			"label": "Custom Documentation Page", "description": "Specifies a custom documentation subpage", "example": "Template:Documentation/doc", "type": "string", "suggested": true },		"content": { "label": "Inline Documentation Content", "description": "Only use for very short documentation. Tables are not processed in here", "example": "This template is used for quotes", "type": "unbalanced-wikitext" },		"sandbox": { "label": "Custom Sandbox Subpage", "description": "Specifies a different sandbox subpage", "example": "Template:Documentation/sandbox", "type": "string" },		"testcases": { "label": "Custom Testcases Page", "description": "Specifies a different testcases subpage", "example": "Template:Documentation/testcases", "type": "string" },		"heading": { "label": "Heading text", "description": "Changes the default \"Documentation\" header to a different one", "example": "About this template", "type": "string" },		"footer": { "label": "Custom footer content", "description": "Replaces the default link box with a custom one", "example": "Documentation is automatically generated by . It's contents are shown here.", "type": "unbalanced-wikitext" },		"footertext": { "label": "Custom \"transcluded\" text", "description": "Replaces the \"Documentation is transcluded by\" text", "example": "Documentation is created at ", "type": "string" }	},	"description": "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.", "format": "block" }

de:Vorlage:Dokumentaion fr:Modèle:Documentation hi:साँचा:प्रलेख ja:Template:Documentation pt:Predefinição:Documentação tr:Şablon:Belgelendirme zh:Template:Documentation

fr:Modèle:Documentation/doc tr:Şablon:Belgelendirme/belge