Template:In category
Note to editors: Please don't categorize this template by editing it directly. Instead, place the category in its documentation page, in its "includeonly" section.
The {{In category}} template is designed for use on the documentation subpages of templates. It produces a hatnote that specifies into which category the documented template is categorised.
Basic usage is along the lines of {{In category|Candidates for speedy deletion}}
, which produces the following message:
It is possible to specify more than one category, e.g. {{In category|Candidates for speedy deletion|Candidates for speedy deletion by user}}
produces:
Up to five categories are supported.
To override the "and" with another conjunction, use the |and=
parameter.
For example, {{In category|Candidates for speedy deletion|Candidates for speedy deletion by user}}
would produce:
This template does nothing to change the functionality of the documented template: in particular, it will not actually apply the categories. Its purpose is simply to produce a note about what the documented template does, but you will need to implement the template's actual functionality separately.
TemplateData for In category
{
"params": {
"1": {
"label": "Category 1",
"description": "The first category into which the documented template categorises",
"type": "unknown",
"required": true
},
"2": {
"label": "Category 2",
"description": "The second category into which the documented template categorises"
},
"3": {
"label": "Category 3",
"description": "The third category into which the documented template categorises"
},
"4": {
"label": "Category 4",
"description": "The fourth category into which the documented template categorises"
},
"5": {
"label": "Category 5",
"description": "The fifth category into which the documented template categorises"
},
"and": {
"label": "Override for \"and\"",
"description": "A word to use instead of \"and\" when writing the lists of categories that the documented template categorises into. Only used if at least two templates are listed.",
"example": "or",
"type": "content",
"suggestedvalues": [
"or"
],
"default": "and"
}
},
"description": "Produces a note about which categories a template will categorize the pages it's applied to into.",
"paramOrder": [
"1",
"2",
"3",
"4",
"5",
"and"
],
"format": "inline"
}