Template:Category header

This category contains pages and subcategories belonging to the topic Category header.

Template documentation[view] [edit] [history] [purge]

Usage

This template should be placed at the top of a category page. It produces a sentence that briefly explains the purpose of the category and it classifies the category into a number of different kinds of category.

Parameters

The full list of parameters is:

{{Category header
| shortcut/sc   = 
| shortcut1/sc1 = 
| shortcut2/sc2 = 
| shortcut3/sc3 = 
| shortcut4/sc4 = 
| shortcut5/sc5 = 
| name          = 
| first         = 
| container     = 
| subcategories = 
| lists         = 
| class         = 
| type          = 
| topic         = 
| individual    = 
| template      = 
| parameter     = 
| variant       = 
| hidden        = 
| contents      = 
| from          = 
| to            = 
}}

Not all parameters should nor can be used together. All the parameters are optional, unless otherwise noted; however, not using them when they should be used may produce a warning or misleading information.

• shortcut: Enter a redirect shortcut (without wikilink) to appear in a shortcut box at the right of the message box.
• shortcut1: Use the numbered shortcut parameters to enter up to five shortcuts.
• name: Enter the name of the category how it should be written in the middle of a sentence. Apart from in tracking categories (see type), the text entered in this parameter will be wiki-linked in the first sentence, unless the first parameter is used. This parameter is unnecessary if the name of the category is already how it should be written in the middle of a sentence or if the first parameter is used in any category other than a double category or set category (see type). This parameter is also unnecessary for tracking categories. If neither this parameter nor the first parameter are used, the page name will be wiki-linked.
• first: Enter a descriptive name for the category, written how it should be written in the middle of a sentence, and attach appropriate wiki-links. This parameter is unnecessary if the wiki-link is identical to the name of the category or the text entered in the name parameter. This parameter is also unnecessary for tracking categories (see type). This parameter can be used to provide the name of the category in a slightly different format for the first time it is mentioned in the category description, or to display the name without a link.
• container: Enter yes for categories containing only subcategories.
• subcategories: Enter no if the category does not contain any subcategories and is unlikely to in the future (e.g. Category:All disambiguation pages).
• lists: For double categories, set categories and set-and-topic categories (see type), enter no if the category does not contain any lists and is unlikely to in the future.
• class: Enter the name of the category class (only 1):
  • admin: For categories that are part of the administration of Wikipedia.
  • content: For categories that contain encyclopaedic contents.
  • contents: For contents pages at the top of the category tree.
• type: Enter the name of the category type (only 1):
  • intermediate: For categories named "X by Y" that only contain subcategories. These categories are always container categories (see contents).
  • set: For categories containing a set of group members.
  • double: For set categories that also contain the members' corresponding categories.
  • tracking: For set categories populated by a template.
  • topic: For categories containing pages related to a particular topic.
  • set-and-topic: For categories containing both a set and a topic.
  • universal: For categories containing all pages in the subcategories of the related category tree.
• topic: For double categories and set categories (see type), enter the name (without the "Category:" prefix) of the corresponding topic category (see type) if applicable. The topic category is often a parent category of the double category or set category.
• individual: For double and set categories (see type), enter the generic name for a member of the set. This parameter is unnecessary if it is unlikely that there will be any topics about any individual members of the set.
• template: For tracking categories (see type), enter the name (without the "Template:" prefix) of the main template that populates the category. This parameter is required for tracking categories and will not work with other category types.
• parameter: For tracking categories (see type), enter the name of the required parameter of the main template that populates the category if necessary.
• variant: For tracking categories (see type), enter yes if there is more than one template that populates the category.
• hidden: For tracking categories (see type), enter no to not make the category a hidden category.
• contents: This parameter is unnecessary for double categories (see type). It is optional for container categories (see container). Enter the kind of contents contained in the category (only 1):
  • articles For categories containing article pages.
  • categories: For categories containing categories that are not subcategories.
  • disambiguation: For categories containing disambiguation pages.
  • help: For categories containing pages in the help namespace.
  • images: For categories containing image files.
  • lists: For categories containing lists.
  • portals: For categories containing pages in the portal namespace.
  • project: For categories containing pages in the Wikipedia namespace.
  • redirects: For categories containing redirects.
  • stubs: For categories containing stubs.
  • templates: For categories containing pages in the template namespace.
  • users: For categories containing pages in the user namespace.
  • variety: For tracking categories (see type) containing multiple kinds of pages.
• from: For redirect categories (see contents), enter the kind of pages the redirects are.
  • Example: Category:Redirects from misspellings: misspellings or [[typographical error]]s
• to: For redirect categories (see contents), enter the kind of pages the redirect targets are.
  • Example: Category:Redirects from misspellings: the correct spellings

Other category-header templates

The above documentation is transcluded from Template:Category header/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.