မဝ်ဂျူ:labels/data/doc

This is the documentation page for မဝ်ဂျူ:labels/data

This module contains the data used by Module:labels and, by extension, the templates {{label}} and {{term-label}}. It lists all recognised labels, except the many in the submodules, along with other information.

The following are two of several submodules that exist:

The regional and topical labels are all available through {{label}}. In addition, there are language-specific labels; the full list of these submodules can be found here. Language-specific labels override other ones.

Each language data module exports a single table containing labels and/or aliases. 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.
glossary: The anchor in Appendix:Glossary to link to. glossary = true means that the anchor is identical to the label.
Wikipedia: The article in English Wikipedia to link to. Wikipedia = true means that the article's title is identical to the label.; For glossary and Wikipedia, the link text will be identical to the label. To show different link text, change the text of the label (while adding aliases["<old_label>"] = "<new_label>"), or add a piped link to display.
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 {{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.
deprecated: Marks the label as deprecated if the value is set to true. When a deprecated label identifier is used, the label is wrapped in <span class="deprecated-label"></span> and the page is added to Category:Entries with deprecated labels.

Aliases

Aliases 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. ထာမ်ပလိက်:label/example

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.

For a single alias, you can use:

labels["<alternative label>"] = "<label with data table>"

For a list of aliases, you can use:

alias("<label with data table>", {"<alternative label 1>", "<alternative label 2>", ... "<alternative label n>"})

To mark an alias (but not the label it points to) as deprecated, some more involved syntax is required:

labels["<alternative label>"] = { alias_of = "<label with data table>", deprecated = true }