These templates serve as sources of documentation for other templates (i.e., explaining their purpose and proper usage). They all follow the naming scheme:
- Template:Name/doc
where "Template:" is the namespace prefix for templates, Name is the name of the template being documented, and "/doc" is the standard marker of a template-documentation subpage.
The purpose of this standard naming system is so that the documentation can be transcluded into the template with the relatively simple template call:
- <noinclude>{{doc}}</noinclude>
(See Template:Doc for additional information.)
Not all templates need to be documented on a separate page like this. In general, templates that are only used once per page (such as navigational templates) can be documented in the template itself (between <noinclude> and </noinclude> tags), but templates that are likely to be used repeatedly in the same page (such as wikicode templates) should be documented on a subpage.
All template documentation should be categorized here and not in any other categories (for now, at least).
When creating subpage documentation, remember to add
- [[Category:Template subpage documentation|Name]]
to the bottom of the page, using the name of the template being documented (i.e., without the "/doc" suffix) as a sortkey.
All items (11)