View source for Template:Maintenance category/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and other interwikis at Wikidata -->
{{high-use}} 
{{Never substitute}}
{{Template redirect|Wikipedia category}}
__TOC__

== Usage ==
This template should be placed at the top of categories used in the [[Wikipedia:Maintenance|maintenance of Wikipedia]], rather than as part of the encyclopedia&nbsp;— for example, at the top of [[:Category:Wikipedia administration]].

===Parameters===
The following descriptions assume the template is [[Help:Transclusion|transcluded]] on a page in the [[Help:Category|Category namespace]].

{{Aligned table
 |col1style=line-height:1.4em;padding-right:1.5em;padding-bottom:0.5em;width:25%;
 |col2style=line-height:1.4em;padding-bottom:0.5em;width:74%;

 | {{para|container|true/yes}}
 | Causes the template to add the page (the category) to [[:Category:Container categories]] and include a {{tlx|Container category}} style message. To inhibit self-categorisation, set {{para|container_category|no}}.

 | {{para|tracking|true/yes}}
 | Causes the template to add the page (the category) to [[:Category:Tracking categories]] and include a {{tlx|Tracking category}} style message. To inhibit self-categorisation, set {{para|tracking_category|no}}.

 | {{para|purpose}}
 | To add a short explanation of the tracking category after the message, use {{para|purpose|<var>Short explanation.</var>}} The {{para|tracking}} parameter must be set to true or yes to display.

 | {{para|desc}}
 | Text supplied will be placed below the template with a boldfaced header of "Description:". The word "Description" can be replaced by something else, using {{para|alt|Something else}}.

 | {{para|hidden|true/yes}}
 | Causes the template to hide the page (the category), add it to [[:Category:Hidden categories]] and to include a {{tlx|Hidden category}} style message. Using {{para|tracking|false/no}} or {{para|tracking|true/yes}}, in addition, will give slightly different messages in the box.

 | {{para|empty|true/yes}}
 | Includes a {{tlx|Possibly empty category}} style message. In addition, to add a short explanation of the empty category after the message, use {{para|empty_text|<var>Short explanation.</var>}}

 |{{para|polluted|false/no}}
 | Exclude categories that legitimately contain pages in both the (Main) [[Wikipedia:Namespace|namespace]] and the user namespace from [[Wikipedia:Database reports/Polluted categories]].

 | {{para|shortcut1}}
 | Enables a [[WP:Shortcut|shortcut]] to the category to be displayed by the template.<br />Multiple shortcuts are supported: from {{para|shortcut1}}, up to {{para|shortcut5}}.
}}

===Aliases===
{{WPBannerDoc/alias|desc|1}}
{{WPBannerDoc/alias|desc|1|literal=yes}}
{{WPBannerDoc/alias|alt|ALTTEXT}}
{{WPBannerDoc/alias|purpose|description}}
{{WPBannerDoc/alias|shortcut|shortcut1}}

== Examples ==
{{center|{{large|'''Code'''}}}}
<syntaxhighlight lang="wikitext" style="position:relative;bottom:9px;">
{{Maintenance category
|shortcut=CAT:WCAT
|hidden=true
|tracking=false
|purpose=This category tracks pages tagged with {{tl|Citation needed}}.<!-- This text will not display since "tracking" is set to "false"-->
|desc=Category for articles (and other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verification, using the {{tlx|Citation needed}} template. Does not include discussion pages tagged with {{tlx|Talkfact}}.
}}
</syntaxhighlight>

{{Maintenance category
|shortcut=CAT:WCAT
|hidden=true
|tracking=false
|purpose=This category tracks pages tagged with {{tl|Citation needed}}.
|desc=Category for articles (and other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verification, using the {{tlx|Citation needed}} template. Does not include discussion pages tagged with {{tlx|Talkfact}}.
|tracking_category=no|container_category=no
}}

{{center|{{large|'''Code'''}}}}
<syntaxhighlight lang="wikitext" style="position:relative;bottom:9px;">
{{Maintenance category
|tracking=true
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
}}
</syntaxhighlight>
{{Maintenance category
|tracking=true
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
|tracking_category=no|container_category=no
}}

{{center|{{large|'''Code'''}}}}
<syntaxhighlight lang="wikitext" style="position:relative;bottom:9px;">
{{Maintenance category
|empty=true
|empty_text=This category is tracking [[academic journal]]s by the {{para|frequency}} parameter of their {{tl|Infobox journal}}.  This category should ideally be empty, but will be populated when non-standard {{para|frequency}} parameters are used.
|alt='''Alternative text''':
|desc=Usage with the {{para|alt}} parameter.
}}
</syntaxhighlight>
{{Maintenance category
|empty=true
|empty_text=This category is tracking [[academic journal]]s by the {{para|frequency}} parameter of their {{tl|Infobox journal}}.  This category should ideally be empty, but will be populated when non-standard {{para|frequency}} parameters are used.
|alt='''Alternative text''':
|desc=Usage with the {{para|alt}} parameter.
|tracking_category=no|container_category=no
}}

== See also ==
{{Other category-header templates}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Category namespace templates]]
[[Category:Tracking templates]]
}}</includeonly>