nsTeam2RO, nsTeam2RW, nsTeam2_talkRO, nsTeam2_talkRW
13,254
edits
Changes
Jump to navigation
Jump to search
mLine 36:
Line 36: − + − +
→Documentation on the template page: formatting with template
# Write the full documentation.
# Write the full documentation.
# Put a link to another page which itself contains the documentation.
# Put a link to another page which itself contains the documentation.
# Write the documentation on another page (usually a sub-page), and include that other page on the template page using the template syntax. For example: <small><tt><nowiki><noinclude>{{<template-name>/doc}}</noinclude></nowiki></tt></small> will place the contents of the "doc" sub-page of the template on the template page itself.
# Write the documentation on another page (usually a sub-page), and include that other page on the template page using the template syntax. For example: {{tt|<nowiki><noinclude>{{<template-name>/doc}}</noinclude></nowiki>}} will place the contents of the "doc" sub-page of the template on the template page itself.
Methods 2 and 3 are useful if the template itself is locked from editing, as it still allows the documentation itself to be edited by any editor.
Methods 2 and 3 are useful if the template itself is locked from editing, as it still allows the documentation itself to be edited by any editor.
The following two templates should be placed on the documentation page of all templates. In some cases, these two templates are all that is required, but often other information should be added also.
The following two templates should be placed on the documentation page of all templates. In some cases, these two templates are all that is required, but often other information should be added also.
* {{tl|TemplateDoc}} This is a brief description of the template.
* {{tl|TemplateDoc}} This is a brief description of the template.
* {{tl|Parms}} This is a container for a list of parameters. If there are no parameters, just place <nowiki>{{Parms|}}</nowiki> on the page.
* {{tl|Parms}} This is a container for a list of parameters. If there are no parameters, just place {{tt|<nowiki>{{Parms|}}</nowiki>}} on the page.
* {{tl|Parm}} This comprises the details of a single parameter. Use one of these for each parameter in the template, with all of them comprising the one parameter required for the {{tl|Parms}} macro.
* {{tl|Parm}} This comprises the details of a single parameter. Use one of these for each parameter in the template, with all of them comprising the one parameter required for the {{tl|Parms}} macro.
** Note that in a few cases with many straight-forward parameters which are obvious from the template itself, it is not necessary to list each one of them individually. See {{tl|planet}} for an example.
** Note that in a few cases with many straight-forward parameters which are obvious from the template itself, it is not necessary to list each one of them individually. See {{tl|planet}} for an example.