Template:Topic cat

From The Languages of David J. Peterson
Jump to navigation Jump to search

This template should be used on pages in the Category: namespace, and automatically generates descriptions and categorization for categories of a recognized type (see below). It is implemented by Module:category tree and its submodule Module:category tree/topic cat. It is preferable not to invoke this template directly, but to simply use {{auto cat}} (with no parameters), which will automatically invoke this template on appropriately-named category pages.


This template automatically generates descriptions and categorization for categories whose name follows the format "(language code):(label)" and "(label)".

Parameters

|1=
The language code (see Project:Languages) of the language that the category name begins with, and which the category's contents belongs to. Leave this empty for categories that do not start with a language code.
|2=
The label of the category. This is the part of the category name that follows the language code.
Note

This template can now figure out any missing parameters from the name of the category, but parameters which are included must be correct.

Examples

Adding, removing or modifying categories

The information on each label for this template is contained in Module:category tree/topic cat/data and its submodules. For a list of all data modules, see Category:Category tree data modules/topic cat.

The following values are recognised in these data modules:

parents
A table listing one or more parent labels of this label.
  • An item in the table can be either a single string, or a table containing two elements called name and sort. In the latter case, name value specifies the parent label name, while the sort value specifies the sort key to use to sort it in that category.
  • If a parent label begins with Category: it is interpreted as a raw category name, rather than as a label name. It can still have its own sort key as usual.
description
A plain English description for the label. In addition to regular text, the following special keywords are available to generate "default" descriptions.
  • "default"
  • "default with capital"
  • "default with the"
  • "default with the lower"
  • "default with topic"
These are inserted in this way:
  • description = "default with topic",

Special template-like parameters can be used inside the parents and description values. These are replaced by the equivalent text.

{{{langname}}}
The name of the language that the category belongs to.
{{{langcat}}}
The name of the language's main category, which adds "language" to the regular name.

For description, these are also available:

{{{label_uc}}}
The label name with its first character in uppercase.
{{{label_lc}}}
The label name with its first character in lowercase.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Topic cat

Provides information about the topic of a category, such as Category:Sciences or Category:en:Light sources

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
language code1

The language code of the language that the category name begins with, and which the category's contents belongs to. Leave this empty for categories that do not start with a language code.

Unknownrequired
label2

The label of the category. This is the part of the category name that follows the language code.

Unknownrequired