Template:Maintenance category

This is an administrative 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 (except for eponymous maintenance categories).

Template documentation follows
Note: the template above may sometimes be partially or fully invisible.
Visit "Template:Maintenance category/doc" to edit its documentation if it is available. (How does this work?)

Usage

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

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

• 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

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 an administrative 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 (except for eponymous maintenance 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 an administrative 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 (except for eponymous maintenance 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}}.

• This category is hidden on its member pages—unless the corresponding user preference (Appearance → Show hidden categories) is set.
• These categories can be used to track, build and organize lists of pages needing "attention en masse" (for example, pages using deprecated syntax), or that may need to be edited at someone's earliest convenience.
• These categories also serve to aggregate members of several lists or sub-categories into a larger, more efficient list (discriminated by classifications).

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 an administrative 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 (except for eponymous maintenance 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

No description.

Template parameters[Edit template data]

This template prefers inline formatting of parameters.

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

Other category-header templates

Template:Maintenance category invokes Module:Navbox using Lua.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

• Groups: Currently there is no technical limit to the maximum number of groups.
  • Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
• Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
• Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
  • Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
• Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
• Bullets: Create unordered lists with lines beginning with *.
• Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

• Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
  • Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
• Uncollapsed: Forces the navbox to be displayed.
  • All of the navboxes in this documentation are in the uncollapsed state.
• Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
  • Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
• Plain: Removes the "show/hide" link.

Sub-groups

• For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
• To create sub-groups within {{navbox}}, certain parameters are to be included:
  • The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
  • The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

• For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
• To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
  • The parent navbox is almost always uncollapsed (state=uncollapsed).
  • The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
  • The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
  • The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

• The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
• Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.