Template:Maintenance category/doc
Appearance
This is a documentation subpage for Template:Maintenance category. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 39,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template should not be substituted. |
Usage
[edit]This template should be placed at the top of categories used in the maintenance of Wikipedia, rather than as part of the encyclopedia — for example, at the top of Category:Wikipedia administration.
Parameters
[edit]The following descriptions assume the template is transcluded on a page in the Category namespace.
|container=true/yes | Causes the template to add the page (the category) to Category:Container categories and include a {{Container category}} style message. To inhibit self-categorisation, set |container_category=no . |
|tracking=true/yes | Causes the template to add the page (the category) to Category:Tracking categories and include a {{Tracking category}} style message. To inhibit self-categorisation, set |tracking_category=no . |
|purpose= | To add a short explanation of the tracking category after the message, use |purpose=Short explanation. The |tracking= parameter must be set to true or yes to display. |
|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 |alt=Something else . |
|hidden=true/yes | Causes the template to hide the page (the category), add it to Category:Hidden categories and to include a {{Hidden category}} style message. Using |tracking=false/no or |tracking=true/yes , in addition, will give slightly different messages in the box. |
|empty=true/yes | Includes a {{Possibly empty category}} style message. In addition, to add a short explanation of the empty category after the message, use |empty_text=Short explanation. |
|polluted=false/no | Exclude categories that legitimately contain pages in both the (Main) namespace and the user namespace from Wikipedia:Database reports/Polluted categories. |
|shortcut1= | Enables a shortcut to the category to be displayed by the template. Multiple shortcuts are supported: from |shortcut1= , up to |shortcut5= . |
Aliases
[edit]- The first positional parameter is recognised as an alias for
|desc=
. If both|desc=
and the positional parameter are present, the positional parameter is ignored.
- The parameter
|1=
is recognised as an alias for|desc=
. If both|desc=
and|1=
are present,|1=
is ignored.
- The parameter
|ALTTEXT=
is recognised as an alias for|alt=
. If both|alt=
and|ALTTEXT=
are present,|ALTTEXT=
is ignored.
- The parameter
|description=
is recognised as an alias for|purpose=
. If both|purpose=
and|description=
are present,|description=
is ignored.
- The parameter
|shortcut1=
is recognised as an alias for|shortcut=
. If both|shortcut=
and|shortcut1=
are present,|shortcut1=
is ignored.
Examples
[edit]Code
{{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}}.
}}
This is a maintenance category, used for maintenance of the Wikipedia project. It is not part of the encyclopedia and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.
This is a hidden category. It is not shown on its member pages, unless the corresponding user preference (Appearance → Show hidden categories) is set. |
Description: Category for articles (and other pages, such as portals and mainspace-intended templates) tagged as needing or more citations for verification, using the
{{Citation needed}}
template. Does not include discussion pages tagged with {{Talkfact}}
.Code
{{Maintenance category
|tracking=true
|purpose=This category tracks pages that use {{tlx|albumchart|Billboard200}}.
}}
This is a maintenance category, used for maintenance of the Wikipedia project. It is not part of the encyclopedia and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.
This is a tracking category. It builds and maintains a list of pages primarily for the sake of the list itself. They are not part of the encyclopedia's categorization scheme.
This category tracks pages that use {{albumchart|Billboard200}} .
|
Code
{{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.
}}
This is a maintenance category, used for maintenance of the Wikipedia project. It is not part of the encyclopedia and contains non-article pages, or groups articles by status rather than subject. Do not include this category in content categories.
Administrators: Please do not delete this category even if it is empty! This category may be empty occasionally or even most of the time. This category is tracking academic journals by the |frequency= parameter of their {{Infobox journal}}. This category should ideally be empty, but will be populated when non-standard |frequency= parameters are used. |
Alternative text: Usage with the
|alt=
parameter.TemplateData
[edit]No description.
Parameter | Description | Type | Status | |
---|---|---|---|---|
category | category | no description | Page name | optional |
container | container | no description | Boolean | optional |
container_category | container_category | no description | Page name | optional |
tracking | tracking | no description | Boolean | optional |
tracking_category | tracking_category | no description | Page name | optional |
purpose | purpose description | no description | String | optional |
hidden | hidden | no description | Boolean | optional |
empty | empty | no description | Boolean | optional |
empty_text | empty_text | no description | String | optional |
polluted | polluted | no description | Boolean | optional |
shortcut | shortcut shortcut1 | no description | Line | optional |
shortcut2 | shortcut2 | no description | Line | optional |
shortcut3 | shortcut3 | no description | Line | optional |
shortcut4 | shortcut4 | no description | Line | optional |
shortcut5 | shortcut5 | no description | Line | optional |
nocat | nocat | no description | Boolean | optional |
desc | desc 1 | no description | String | optional |
alt | alt ALTTEXT | no description | String | optional |
See also
[edit]Other category-header templates
[edit]