{{label data documentation}}
.
Each data module defines and exports a table called labels
containing the data associated with the actual labels. The key is the label while the value is a table containing information on the label. The following is a basic example:
labels = { aliases = {"Argentinian"}, Wikipedia = true, regional_categories = "Argentinian", }
This defines a label Argentina
with an alias Argentinian
, links the label to the Wikipedia article Argentina, and causes uses of the label with {{lb}}
or {{tlb}}
to categorize into Argentinian lang
where lang
is the language of the label.
The following is a more complex example, for use in Module:labels/data/lang/en:
labels = { region = "Great Britain", addl = "Not to be confused with ], a spelling system used in some English-speaking countries of the world.", aliases = {"Britain", "Great Britain"}, Wikipedia = "British English", regional_categories = true, parent = "Europe,Commonwealth", country = "the United Kingdom", }
This defines a label British
with two aliases Britain
and Great Britain
, all of which display as British
and link to the Wikipedia article British English. Use with {{lb}}
or {{tlb}}
categorize into British English. The fields region
, addl
, parent
and country
control the appearance of the category text for the category British English.
The following table specifies the basic fields. See the documentation of Module:labels/data for more detailed information.
Field | Example | Description |
---|---|---|
aliases |
{"Britain", "Great Britain" } |
List of aliases for the label. |
display |
"Taraškievica orthography" or "] ]s" |
How the label displays (if different from the label itself). |
Wikipedia |
"Shopi#Dialects" or true or {"Goan Portuguese", "Portuguese India" } |
Wikipedia article to link to, or true if the article is named the same as the (canonical form of the) label. Multiple articles can be provided; only the first is used for linking the label, but all are displayed on the label's category page.
|
Wiktionary |
"Appendix:Swedish verbs" |
Wiktionary article to link to, or true if the anchor is named the same as the (canonical form of the) label.
|
Wikidata |
"Q2675834" or {"Q98095139", "Q9668261" } |
Wikidata ID or ID's identifying one or more Wikipedia articles to link to. Multiple ID's can be provided; only the first associated article is used for linking the label, but all are displayed on the label's category page. |
glossary |
"tashif" |
The anchor in Appendix:Glossary to link to, or true if the anchor is named the same as the (canonical form of the) label.
|
langs |
{"la", "lad", "nrf", "vi", "yi" } |
Language restriction for this label, for labels not occurring in a language-specific module. The label will only be recognized for the specified language code(s). |
The following table specifies the fields used to control how the label categorizes when used with {{lb}}
or {{tlb}}
.
Field | Example | Description |
---|---|---|
plain_categories |
"Multicultural Toronto English" or true or {"American English forms", "Oxford spellings" } |
Category or categories to add the page to, when {{lb}} or {{tlb}} are used; use true if the category is the same as the (canonical form of the) label.
|
regional_categories |
"Algerian" or true or {"Devonian", "Somerset" } |
Like plain_categories but the language name is appended to the specified value(s).
|
pos_categories |
"pluralia tantum" or true or {"transitive verbs", "intransitive verbs" } |
Like plain_categories but the language name is prepended to the specified value(s).
|
topical_categories |
"Football (American)" or true or {"Software engineering", "Programming" } |
Like plain_categories but the language code is prepended to the capitalized specified value(s).
|
sense_categories |
"dated" or true or {"obsolete", "historical" } |
Categorizes into lang terms with category senses (when using {{lb}} ) or lang category terms (when using {{tlb}} ).
|
The following table specifies the fields used to control the appearance of the category page (specified using plain_categories
or regional_categories
) for labels that specify lects (i.e. language varieties).
Field | Example | Description |
---|---|---|
region |
"the ]" or "the tri-state region of <country>" or "]s in {{w|Acadiana|Southern Louisiana}}" |
Region where the lect specified by the label is used; or the users of the lect, if prep = "by" is given. Defaults to the label. The spec <country> is replaced by the value(s) specified using the country field; see below.
|
the |
true |
Causes the default value for region to have the word the prepended (e.g. for a label such as Philippines or Channel Islands ).
|
prep |
"by" |
Preposition used in the category description, after Terms or senses in lang as spoken, in place of in.
|
verb |
"originally spoken" or "used" |
Verb used in the category description, after Terms or senses in lang as, in place of spoken.
|
def |
"], a Spanish ] with origins in ]" |
Definition text used in the category description, after Terms or senses in. Defaults to lang as spoken in region , where lang is the language and region is the value of the region field.
|
fulldef |
"Anglo-Indian terms or senses in English as used formerly by Britishers in {{w|British India}}" |
Definition text used in the category description. Defaults to Terms or senses in lang as spoken in region ; see the def field.
|
addl |
"Not to be confused with the {{catlink|Bavarian language}}." |
Additional text to display on the label's category page. |
parent |
"New England" or true or "Southern US,Southwestern US" |
Parent label(s). The category corresponding to the label will have the category or categories of the parent label(s) as its parent(s). If true , the parent will be Regional lang , or Varieties of lang if noreg = true is given.
|
noreg |
true |
Specify that this lect is non-regional (not a topolect). Used e.g. with chronolects such as Early Modern English and sociolects such as Katharevousa. Controls the default parent when parent = true is used.
|
othercat |
"en:Universities" or "British slang,English cant,English gay slang" |
Additional category or categories to add the label's category page to. Useful especially for categories not associated with a label. |
country |
"France" or "Belgium,the ],Germany" |
Country or countries where this label's lect is spoken. Used in two ways: (1) to add the label's category to pages such as Category:Languages of France or Category:Languages of the Netherlands; (2) to substitute into the <country> spec in the description.
|
The following table specifies the remaining fields, used mostly to control how the label displays.
Field | Example | Description |
---|---|---|
deprecated |
true |
Indicate that this label is deprecated (should not be used). Such labels display with the deprecated-label CSS class and cause the page to be added to Category:Entries with deprecated labels.
|
deprecated_aliases |
{"dual" } |
Specify deprecated aliases of the given label (i.e. aliases that should not be used). Usage of such aliases causes the label to display with the deprecated-label CSS class and the page to be added to Category:Entries with deprecated labels.
|
track |
true |
Track all usages of this label (including any aliases) at a page named Wiktionary:Tracking/labels/label/label where label is the canonical label (click on "See whether another page links to "), and also at a page named Wiktionary:Tracking/labels/label/label/code , where code is the language code specified in |1= .
|
special_display |
] |
Like display but <canonical_name> is replaced with the canonical language name.
|
omit_preComma |
true |
Don't display a comma before the label, for labels like and , by , _ and ; .
|
omit_postComma |
true |
Don't display a comma after the label, for labels like and , by , _ , ; and chiefly .
|
omit_preSpace |
true |
Don't display a space before the label, for labels like ; and : .
|
omit_postSpace |
true |
Don't display a comma after the label, for labels like - (hyphen), – (en-dash) and — (em-dash).
|
At the end of the data module, the labels
table should be returned using the following code:
return require("Module:labels").finalize_data(labels)