Template:Category
Template documentation follows |
---|
Note: the template above may sometimes be partially or fully invisible. |
Visit Template:Category/doc to edit this documentation. (How does this work?) |
Template:Category standardizes the presentation of all category lede sections. It injects a navigation menu to sort the category by letter, then provides basic information about the category. It is to be used on all category pages.
Usage
Place the following at the very top of the category page, above everything else:
{{category |name = |contains = |namespace = |function = |purpose = |related = |desc =}}
Parameters
The name of the category (omitting "Category:"). This parameter can usually be omitted, as it automatically fills in the category's name. However, this parameter exists to enable the modification of the name.
A short qualifier before the namespace. An example value of this parameter would be "all", which would enable the intro to read as "name
contains all namespace
".
The namespace of the pages that the category contains, of the following options:
main
, produces "articles"file
, produces "files"template
, produces "templates"category
, produces "categories"
If left blank, this parameter will default to "pages", a term that applies to all namespaces. As such, omit this parameter if the category contains pages of different namespaces or namespaces not included in the above list.
A sentence describing the function of the pages included in the category, preceded by "used to" (you may use either function
, purpose
, or related
, but not each). This is only required if further qualifiers need to be added.
A sentence describing the purpose of pages included in the category, preceded by "used for" (in case it is grammatically more appropriate than other options; likewise, only use this parameter in place of function
or related
). This is only required if further qualifiers need to be added.
A sentence describing the relation of pages included in the category to a certain topic, preceded by "related to" (in case it is grammatically more appropriate than "used to" or "used for"; likewise, only use this parameter in place of function
or purpose
). This is only required if further qualifiers need to be added.
A further description of the constituent items of the category (if necessary).