See something you'd like to change or add, but you've never edited an open encyclopædia before? This overview was written to help absolute beginners get started.

Template:Template doc

From A Storehouse of Knowledge
Jump to: navigation, search

Template: Template doc
Use on/in Template documentation pages
Use for Documenting templates (this template)
Category template applies to page (none)
Template Parameters
(See Template style manual).
Name Purpose Required? SMW property Comment
name The name of the template no Defaults to the name of the page
pages Where the template is used, e.g. what type of pages. yes
purpose The purpose of the template yes
cat, page cat A category that the page is added to (see notes) no Defaults to "(none)". See notes A to C
template cat A category for the template no (for now) See note D
other A further value no For use by templates based on this one.
other label The label for a further value yes if other supplied, no otherwise

Note A
This is a category that the template adds to any page on which it is placed. That is, it is a category for categorising the article, not the template. If the template should not add a category to pages, leave this parameter blank (or omit it).
Note B
If more than one category is applied by the template, or alternative categories depending on parameters, put (see note) and list them separately on the documentation page. NB: This has a bug, but do it anyway.
Note C
Parameter cat is deprecated. Use page cat instead.
Note D
Unless a new category is required, use one of the categories below, but omit the word "templates" from the category. For example, for a base template, use template cat=base.
NB: Template categories below may have sub-categories which may also be used.

Data block

The data block below can be copied to the page required to save typing it out.

If a parameter in the data block below has a hash character (#), this indicates that the template supplies a default if the parameter is not supplied. Remove the hash if you want to supply a value to this parameter. See Data block on the Template style manual page for more information. This data block includes the outline for the {{Parms}} and {{Parm}} templates.

{{Template doc
 |#name =
 |pages =
 |purpose =
 |page cat =
 |template cat =
 {{parm|(name)|(description)|(required?)|(SMW property)|(Comments)}}

NB: Adapted from my own work on Conservapedia.

Personal tools

visitor navigation
contributor navigation