Help:Templates/Template documentation

From MeritBadgeDotOrg

(Difference between revisions)
Jump to: navigation, search
m (minor edit)
Current revision (23:51, September 2, 2007) (edit) (undo)
m (add cat)
 
(3 intermediate revisions not shown.)
Line 1: Line 1:
< [[Help:Templates]]
< [[Help:Templates]]
-
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.
+
In MediaWiki, '''Template documentation''' should be provided for end-users that use the '''[[Help:Templates|template]]'''. It is recommended that documentation should appear in a [http://en.wikipedia.org/wiki/Subpages 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:
Suggested methods is to use the following headers for the main body of the documentation:
Line 8: Line 8:
<nowiki>== Usage ==</nowiki>
<nowiki>== Usage ==</nowiki>
''Use <nowiki><pre>{{templatename|var1|var2}}</pre></nowiki> to
''Use <nowiki><pre>{{templatename|var1|var2}}</pre></nowiki> to
-
show the usage of [[Help:Variable|variables]] used in the Template.''
+
show the usage of [http://en.wikipedia.org/Help:Variable variables] used in the Template.''
<nowiki>== Examples ==</nowiki>
<nowiki>== Examples ==</nowiki>
Line 16: Line 16:
''Typically links to other similar templates''
''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.
+
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:Wikipedia templates|{{PAGENAME}}]]
+
[[Category:Templates|{{PAGENAME}}]] [[Category:Help|{{PAGENAME}}]]
-
[[Category:Wikipedia how-to|{{PAGENAME}}]]
+

Current revision

< Help:Templates

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.

Personal tools
language