Template:label/documentation

Uses Lua:

• Module:labels/templates

Use this template, as described in Wiktionary:Context labels:

1. To label senses with restricted usage
2. To label senses with grammatical information, in addition to that in the part-of-speech heading and headword line

This template generates content using Module:labels/templates and Module:labels. Lists of all recognised labels can be found in the following modules:

• Module:labels/data
• Module:labels/data/regional
• Module:labels/data/topical
• Module:labels/data/qualifiers
• Module:labels/data/lang/en (for English-specific labels)
• Module:labels/data/lang/grc (for Ancient-Greek-specific labels)
• Module:labels/data/lang/yo (for Yoruba-specific labels)
• ... (for about 250 languages currently)

To search for a label in these data modules, search on this page starting at #Defined labels or use the search box on the right. To add a label, go to the appropriate data module and follow the directions in the documentation page, or ask someone else to add the label at Module talk:labels/data.

Usage

A label is placed before the definition, such as:

# {{lb|en|AU|colloquial|pejorative}} An [[insidious]] person.

1. (Australia, colloquial, derogatory) An insidious person.

{{lb}}, {{lbl}}, and {{label}} are all equivalent. {{lb}} is preferred for conciseness.

The first parameter is the language code of the section in which the template is placed (e.g. en for English); see WT:LANGLIST for the full list. Further parameters are context labels.

This template provides consistency. The same visual result could be achieved with simpler formatting; however, lb helps to ensure that the same labels are used across the project. For instance, {{lb|en|math}} and {{lb|en|maths}} both produce the same result, expanding to (mathematics).

Use of a context label also provides automatic categorization. For instance, the example above is categorized as Australian English and slang. Likewise, any page with a context of math or maths will be automatically placed in category Mathematics. However, these templates should not be used merely for categorization. It is still preferable to list a [[Category: ]] when there is no specific context for a term.

Regions are meant to indicate where a term is used, not to specify location of an entity. For instance, the Sphinx in Giza should not be labeled Egypt. Rather, that's part of the definition. Also, time and space are not contexts. The word "week" is understood to mean seven days whether one is discussing war or widgets or the weather, in speech or song or storybook.

Examples

Some examples to demonstrate the range of current functionality:

• A single ad hoc context with no supporting template:

{{label|en|foobarbazbip}}

→

(foobarbazbip)

• A single context with supporting template (for categorization and custom label-text):

{{label|en|Australia}}	→	(Australia)
{{label|en|transitive}}	→	(transitive)

• Multiple contexts, with or without supporting templates:

{{label|en|foobar|bazbip}}	→	(foobar, bazbip)
{{label|en|Australia|slang}}	→	(Australia, slang)
{{label|en|foobar|slang}}	→	(foobar, slang)
{{label|en|Australia|foobar|bazbip}}	→	(Australia, foobar, bazbip)

• Multiple contexts, with special built-in separator pseudo-contexts that replace the comma:

{{label|en|foobar|_|bazbip}}	→	(foobar bazbip)
{{label|en|foobar|_|bazbip|slang}}	→	(foobar bazbip, slang)
{{label|en|foobar|or|bazbip}}	→	(foobar or bazbip)
{{label|en|foobar|and|bazbip}}	→	(foobar and bazbip)
{{label|en|foobar|and|bazbip|or|Australia}}	→	(foobar and bazbip or Australia)
{{label|en|Australia|or|foobar}}	→	(Australia or foobar)
{{label|en|Australia|_|foobar|;|British|_|bazbip}}	→	(Australia foobar; British bazbip)

• Qualifier/modifier pseudo-contexts whose supporting templates suppress following comma (by adding a _ parameter):

{{label|en|chiefly|foobar}}	→	(chiefly foobar)
{{label|en|of a|person}}	→	(of a person)

Language-specific labels

An example of a language-specific label:

{{label|grc|Attic}}	→	(Attic)
{{label|en|Attic}}	→	(Attic)

The label is only linked when the language code is grc (representing Ancient Greek).

Redirecting labels

Certain labels are aliases that "redirect" to other labels, or are displayed as them.

{{label|en|African-American Vernacular English}}	→	(African-American Vernacular)
{{label|en|AAVE}}	→	(African-American Vernacular)
{{label|grc|Greek mythology}}	→	(Greek mythology)
{{label|grc|Greek god}}	→	(Greek mythology)
{{label|de|Greek god}}	→	(Greek mythology)

If the wrong language code is used, in this case "de" (German), the label will not be redirected.

{{label|de|African-American Vernacular English}}	→	(African-American Vernacular English)
{{label|de|AAVE}}	→	(AAVE)

Double angle bracket notation

Complex cases involving multiple contexts, especially those that involve pseudo-contexts, are often easier to format using double angle bracket notation. The following shows an example, first using pseudo-contexts and then the equivalent using double angle brackets:

{{label|en|Southern US|where it is|_|now|rare|and|dated|;|and|AAVE|where it is still sometimes used}}	→	(Southern US, where it is now rare and dated; and African-American Vernacular, where it is still sometimes used)
{{label|en|<<Southern US>>, where it is now <<rare>> and <<dated>>; and <<AAVE>>, where it is still sometimes used}}	→	(Southern US, where it is now rare and dated; and African-American Vernacular, where it is still sometimes used)

Comma-separated arguments inside of double angle brackets are split if the comma is not followed by a space. You can also mix regular and double angle bracket arguments. For example, the following are all equivalent:

{{label|en|<<UK,Australia,NZ>> or traditional <<NYC>>}}	→	(UK, Australia, New Zealand or traditional New York City)
{{label|en|<<UK>>, <<Australia>>, <<NZ>> or traditional <<NYC>>}}	→	(UK, Australia, New Zealand or traditional New York City)
{{label|en|UK|Australia|NZ|or|traditional|_|NYC}}	→	(UK, Australia, New Zealand or traditional New York City)
{{label|en|UK|Australia|NZ|or|traditional <<NYC>>}}	→	(UK, Australia, New Zealand or traditional New York City)

Suppressing canonicalization of labels

Labels are normally converted to their canonical forms, for consistency. For example, Australian automatically displays as Australia rather than Australian. In some circumstances, however, this is undesirable. To suppress this, precede the label with an exclamation point (!). For example:

{{label|en|Arab|_|Australian}}	→	(Arab Australia)
{{label|en|Arab|_|!Australian}}	→	(Arab Australian)
{{label|en|Arab <<!Australian>>}}	→	(Arab Australian)

Forcing a label to display a particular way

An extension of the previous notation, <var>label</var>!<var>display</var>, allows you to display <var>label</var> as <var>display</var> in place of how it would normally display. This works both in regular and double angle bracket notation, for example:

{{label|en|<<Southern US!Southern>> and <<Midland US>>}}	→	(Southern and Midland US)
{{label|en|Southern US!Southern|and|Midland US}}	→	(Southern and Midland US)

Additional parameters

|sort=

Sortkey. Usually can be generated automatically from the page name.

|nocat=1

Don't add categories.

See also

• {{term-label}} or {{tlb}}
• {{qualifier}}
• {{sense}}
• {{gloss}}

Other templates that make use of the same context labels:

• {{alt}} or {{alter}}: after two vertical bars
• {{alternative form of}}, {{standard spelling of}}, etc.: in the |from= parameter
• {{syn}}, {{ant}}, and other "nyms" templates: in the |lb=, |lb2=, etc. parameters and the <lb:...> inline modifier
• {{quote-book}}, {{quote-journal}} and other quote templates: in the |lb= parameter
• {{desc}} or {{descendant}}: in the |lb=, |lb2=, etc. parameters and the <lb:...> inline modifier

TemplateData

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

TemplateData for label

Use this template to label senses with restricted usage or grammatical information, in addition to that in the part-of-speech heading and headword line

Template parameters[Edit template data]

Parameter		Description	Type	Status
language	1	The language of the current section Example en	String	required
label 1	2	first label Example slang	String	required
label 2	3	second label Example Australia	String	optional
label 3	4	third label Example UK	String	optional