Template:Label/documentation

Use this template, as described in 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 at Module:labels/data, Module:labels/data/regional, Module:labels/data/topical, Module:labels/data/subvarieties. To search for a label in these data modules, 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:


 * 1)  An insidious person.

Note that, and  are all equivalent;  is preferred for conciseness.

The first parameter is the language code of the section in which the template is placed (e.g.  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,  helps to ensure that the same labels are used across the project. For instance,  and   both produce the same result, expanding to.

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  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 note that 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:


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


 * Multiple contexts (up to about nine), with or without supporting templates:


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


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

Language-specific labels
An example of a language-specific label:

Note that the label is only linked when the language code is  (representing Ancient Greek).

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

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

TemplateData
{	"params": { "1": {			"label": "language", "description": "The language of the current section", "example": "en", "type": "string", "required": true },		"2": {			"label": "label 1", "description": "first label", "example": "slang", "type": "string", "required": true },		"3": {			"label": "label 2", "description": "second label", "example": "Australia", "type": "string" },		"4": {			"label": "label 3", "description": "third label", "example": "UK", "type": "string" }	},	"description": "Use this template to label senses with restricted usage or senses with grammatical information, in addition to that in the part-of-speech heading and headword line" }