Template:Documentation/doc

Description
This is the template, used on many templates for displaying instructions, information, mw:Help:TemplateData, and such.

This template displays two headers like you see now, with the documentation tools at the top, and a link box at the bottom. It automatically loads content from the /doc subpage.

On the Template page
Most of the time, the template takes no parameters, and is placed at the bottom of the template page or other page being documented. The general format is showned here:

Then, this template automatically loads the content from the /doc subpage of the template it is used on. This template can also load the content from any other page. For example:

An alternative way to type documentation is by putting text next to the  parameter, 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

Footer
The bottom footer (or link box) is used for meta-data about the template. The footer will automatically adjust depending on the namespace and parameters given to the template.

To hide the footer, set  to off. To specify a custom footer, set  to anything other that off. Example:

Template source
The template is copied from Template:Documentation (copy) on Templates Wiki.

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": "Inline content for short documentation. Can be combined with the /doc subpage.", "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" }	},	"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 hi:साँचा:प्रलेख/प्रलेख tr:Şablon:Belgelendirme/belge