|
#REDIRECT [[Wikipedia:Template documentation]]
In MediaWiki, '''[[documentation]]''' should be provided for end-users that use the '''[[Help:Template|template]]'''. It is recommended that documentation should appear in a [[Wikipedia:Subpages|subpage]], to separate the template code, and potentially protect the template from any changes. See [[Wikipedia:Template doc page pattern]] how this can be done.
Suggested methods is to use the following headers for the main body of the documentation:
''A single paragraph describing the use.''
<nowiki>== Usage ==</nowiki>
''Use <nowiki><pre>{{templatename|var1|var2}}</pre></nowiki> to
show the usage of [[Help:Variable|variables]] used in the Template.''
<nowiki>== Examples ==</nowiki>
''Show single examples, and how the template should be used''
<nowiki>== See also ==</nowiki>
''Typically links to other similar templates''
If the [[Wikipedia:Template doc page pattern|doc subpage]] method is used, then the categories and interwiki links need to go into specific locations, provided in the pattern template.
[[Category:Wikipedia templates|{{PAGENAME}}]]
[[Category:Wikipedia how-to|{{PAGENAME}}]]
| 