User:Kotniski/Catdesc/doc

This template serves as a universal descriptor for categories. It is currently under construction, and its behaviour is not guaranteed to remain unchanged.

Purpose

The template is designed to be used on category pages. The output it produces consists of two parts. The first part has information addressed to readers (what the category contains, links to related categories, other customized text or links, link to the categories FAQ). The second part contains more technical information addressed chiefly to editors, placed in a collapsible box.

The template also places the current page in the specified parent categories, so there is no need for separate parent category declarations outside the template.

Parameters

Parameters with information for readers

type

This parameter defines the type of category (see WP:Categorization). It can take the values list, topic, list-and-topic, intermediate, project, universal. Defaults to list if omitted.

content

(Required parameter, but "content=" may be omitted.) This defines the category's subject. The output depends on the value of type:

• {{catdesc|species of [[owl]]}} (or {{catdesc|type=list|content=species of [[owl]]}}) produces:

This list category contains Wikipedia articles about species of owl.

• {{catdesc|type=topic|[[owl]]s}} produces:

This topic category contains Wikipedia articles on subjects related to owls.

• {{catdesc|type=list-and-topic|[[owl]]s}} produces:

This list-and-topic category contains Wikipedia articles about owls, including articles related to that general subject.

• {{catdesc|type=intermediate|content=[[owl]]s|subby=country}} produces:

This intermediate category contains categories of owls, organized by country.

• {{catdesc|type=project|[[WP:Template|templates]] for [[owl]]s}} produces:

This project category contains [[WP:Template|templates] for owls.

• {{catdesc|type=universal|[[owl]]s|maincat=Owls}} produces

This universal category contains Wikipedia articles about owls. To see these pages organized into subcategories, see Category:Owls.

maincat

(Required if type=universal; otherwise not used.) The corresponding main (structured) category (see example above).

epon

May take the value here (if eponymous categories corresponding to the members of the present category appear there as well), or other text indicating where such categories can be found (this will be linked automatically if it's a category name).

list

Defines where a corresponding list can be found (will be linked automatically if an article name).

rel1, ..., rel5

Related categories.

reluse1, ..., reluse5

Descriptions of the respective related categories (not required, but if any omitted, then omit all).

more

Any additional text for readers.

Example

Note that this example is intended only to illlustrate the template's functionality, not recommended use.

• {{{User:Kotniski/Catdesc|type=topic|[[owl]]s|epon=here|list=List of owls|reluse1=articles on birds|rel1=Birds|reluse2=other zoology topics|rel2=Zoology|more=Owls here includes species in other biological taxa which are popularly called owls.}} produces:

This topic category contains Wikipedia articles on subjects related to owls.
Some of the pages in this category may themselves have categories named after them; these can be found here as well, listed as subcategories.
A corresponding list of topics can be found at List of owls.
For articles on birds, see Category:Birds.
For other zoology topics, see Category:Zoology.
Owls here includes species in other biological taxa which are popularly called owls.
For general information about using categories, see the FAQ.

Parameters with information for editors

Subcategorization

subc

Can take the values no (has no subcategories), full (is fully diffused into subcategories), partial (is partially diffused into subcategories), dist (has subcategories but is generally not diffused).

distsubc

If subc=partial, describes subcategories which are not diffusing ones.

notdistsubc

If subc=dist, describes subcategories which are diffusing ones.

subby

Text describing how subcategories are organized.

submore

Any additional text about subcategories.

Parent categories

par1, par2, ..., par6

Ordinary parent categories (if defined here, then the category does not need to be placed in them separately).

key1, key2, ...

Sort keys for par1 etc.

dpar1, ...; dkey1, ...

As above, but for parent categories of which this is a distinguished (non-diffusing) subcategory.

epar1, ...; ekey1, ...

As above, but for parent categories of which this is a subcategory only by virtue of its status as an eponymous category.

parmore

Any additional text about parent categories.

Other information

stub

May take the value here (if the present category has one or more stub categories as subcategories) or other text describing where relevant stubs can be found (will be linked automatically if a category name).

sort

Text about how to assign sort keys (set to standard to use standard text; you may then add extra text using sort2=).

edmore

Any additional text for editors.