Help:Templates/Template documentation
From MeritBadgeDotOrg
(Difference between revisions)
m (Oops... always missing something) |
m (add cat) |
||
| (One intermediate revision not shown.) | |||
| Line 18: | Line 18: | ||
Although not required on the MeritBadgeDotOrg wiki, at this time, please consider making use of the [[Help:Templates/Template doc page pattern]] method; then the categories need to go into specific locations, provided in the pattern template. | Although not required on the MeritBadgeDotOrg wiki, at this time, please consider making use of the [[Help:Templates/Template doc page pattern]] method; then the categories need to go into specific locations, provided in the pattern template. | ||
| - | [[Category:Templates|{{PAGENAME}}]] | + | [[Category:Templates|{{PAGENAME}}]] [[Category:Help|{{PAGENAME}}]] |
| - | [[Category: | + | |
Current revision
In MediaWiki, Template documentation should be provided for end-users that use the template. It is recommended that documentation should appear in a subpage, to separate the template code, and potentially protect the template from any changes. See Help:Templates/Template doc page pattern for details 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.
== Usage ==
Use <pre>{{templatename|var1|var2}}</pre> to
show the usage of variables used in the Template.
== Examples ==
Show single examples, and how the template should be used
== See also ==
Typically links to other similar templates
Although not required on the MeritBadgeDotOrg wiki, at this time, please consider making use of the Help:Templates/Template doc page pattern method; then the categories need to go into specific locations, provided in the pattern template.
