View source for Template:Maintenance category/doc

{{Documentation subpage}}
{{High-risk| ≈ 29615 }}
{{nosubst}}

== Usage ==
{{Template redirect|Wikipedia category}}

This template should be placed at the top of categories used in the 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 [[Wikipedia:Transclusion|transcluded]] on a page in the [[Wikipedia:Category namespace|Category namespace]].

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

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

 | {{para|tracking|true/yes/on}}
 | Causes the template to add the page (the category) to [[:Category:Tracking categories]] and include a {{tlx|Tracking category}}-style message.{{smallsup|1}}<br />To add a short explanation of the tracking category after the message, use {{para|purpose|<var>Short explanation.</var>}}
 
 | {{para|hidden|true/yes/on}}
 | Causes the template to hide the page (the category), add it to [[:Category:Hidden categories]] and to include a {{tlx|Hidden category}}-style message. Can only be used if {{para|tracking}} is false since tracking categories are always hidden.

 | {{para|container|false/off}}
 | Causes the template to add the page (the category) to [[:Category:Container categories]] and include a {{tlx|Container category}}-style message.{{smallsup|2}}

 | {{para|empty|false/off}}
 | Include a {{tlx|Possibly empty category}}-style message.<br />To add a short explanation of the empty category after the message, use {{para|empty_text|<var>Short explanation.</var>}}

 | {{para|polluted|false/off}}
 | Exclude categories that legitimately contain pages in both the (Main) [[Wikipedia:Namespace|namespace]] and the user namespace from [[Wikipedia:Database reports/Polluted categories]].
 
 | {{para|desc}} or {{para|1}} or {{!}} (first [[Help:Template#Parameters|unnamed parameter]])
 | Text supplied will be placed below the template with a boldfaced header of "Description:".<br />(The word "Description" can be replaced by something else, with {{para|alt|Something else}}).
}}
{{ublist |style=font-size:95%;padding:0.5em;
 | {{sup|1}} [[:Category:Contents]] categorisation and [[:Category:Tracking categories]] self-categorisation is prevented by setting {{para|tracking_category|true/on}}.
 | {{sup|2}} [[:Category:Container categories]] self-categorisation is prevented by setting {{para|container_category|true/on}}.
}}

== Example ==

{{center|{{big|'''Code'''}}}}
<pre 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}}.
}}
</pre>
{{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|{{big|'''Code'''}}}}
<pre style="position:relative;bottom:9px;">
{{Maintenance category
|tracking=true
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
}}
</pre>
{{Maintenance category
|tracking=true
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
|tracking_category=no|container_category=no
}}

{{center|{{big|'''Code'''}}}}
<pre 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.
}}
</pre>
{{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.
|tracking_category=no|container_category=no
}}

== See also ==

{{Other category-header templates}}

<includeonly>{{Sandbox other||
<!----ADD CATEGORIES BELOW THIS LINE, PLEASE:---->
[[Category:Category namespace templates]]
[[Category:Tracking templates]]
}}</includeonly>