Modul:labels/data/doc

This module contains the data used by Module:labels and, by extension, the templates {{context}}, {{label}}, {{term-context}} and {{term-label}}. It lists all recognised labels along with other information. Regional labels are located in a separate module, Module:labels/data/regional.

Three tables are exported at once: labels, aliases and deprecated. The keys of these tables are label identifiers (passed to the templates), while the values are described below.

Labels

labels contains most data associated with the actual labels.

The following values are supported:

display

The wikitext to display for the label. If this is omitted, the displayed text will default to the label's identifier.

plain_categories

A list of categories that this label should add to a page. The categories are not adjusted depending on the language; they will be taken verbatim, and entries in all languages will be added to the same category. As this is generally undesirable, the plain_categories value should only be used when a label would only ever be used for a single language.

topical_categories

A list of language-dependent topical categories that this label should add to a page. These categories are of the form "[language code]:[category name]". For example, Category:en:Physics.

pos_categories

A list of language-dependent part-of-speech-like categories that this label should add to a page. These categories are of the form "[language name] [category name]". For example, Category:English pluralia tantum.

sense_categories

A list of sense-dependent categories that this label should add to a page. Depending on the template used, categories are either of the form "[language name] terms with [category name] senses" (when using {{context}}/{{label}}) or "[language name] [category name] terms" (when using {{term-context}} or {{term-label}}). For example, Category:English archaic terms and Category:English terms with archaic senses.

regional_categories

A list of language-dependent regional/dialect categories that this label should add to a page. These categories are of the form "[category name] [language name]". For example, Category:British English.

Aliases

Aliases are not labels, but work like redirects to proper labels. When a label is defined here, it "behaves" as if it were the label it "redirects" to. For example, if "American" is listed as an alias of "US", then whenever the label "American" is used in an entry, it's treated as if the label "US" had been used in its place.

The label that an alias points to does not have to be defined in the list itself. So if you want to make "American" an alias of "US", but do not create a full label for "US", that works too.

Double aliases (an alias of another alias) are not supported, and will cause a script error if used.

Deprecated

The deprecated table can be used to mark labels as deprecated. The key should be an identifier, and the value should be set to true. When a deprecated label identifier is used, the label is wrapped in a <span class="deprecated-label"> and the page is added to Category:Entries with deprecated labels. A single alias may be deprecated instead of the entire label.