imported>Ais523: expand stub documentation for Template:In category into a full documentation subpage

2022-07-18T06:13:07Z

expand stub documentation for Template:In category into a full documentation subpage

New page

{{Documentation subpage}}

The {{tl|In category}} template is designed for use on the [[Wikipedia:Template documentation|documentation subpage]]s of templates. It produces a [[Wikipedia:hatnote|hatnote]] that specifies into which category the documented template is categorised.

Basic usage is along the lines of {{tlx|In category|Candidates for speedy deletion}}, which produces the following message:
{{In category|Candidates for speedy deletion}}

It is possible to specify more than one category, e.g. {{tlx|In category|Candidates for speedy deletion|Candidates for speedy deletion by user}} produces:
{{In category|Candidates for speedy deletion|Candidates for speedy deletion by user}}
Up to five categories are supported.

To override the "and" with another conjunction, use the <code>|and=</code> parameter.<br>For example, {{tlx|In category|Candidates for speedy deletion|Candidates for speedy deletion by user|and=or}} would produce:
{{In category|Candidates for speedy deletion|Candidates for speedy deletion by user|and=or}}

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.

<includeonly>{{sandbox other||

[[Category:Template namespace templates|{{PAGENAME}}]]<templatedata>
{
"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"
}
</templatedata>}}</includeonly>

Template:In category/doc - Revision history

imported>Ais523: expand stub documentation for Template:In category into a full documentation subpage