Template:Lang

A checked version of this page, approved on 19 October 2020, was based on this revision.

This content is in the Template Namespace. Used for page-templates that can be re-used across the wiki.

Template documentation[view] [edit] [history] [purge]

This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template uses Lua:

Module:Lang

The purpose of this template is to indicate that a span of text belongs to a particular language. It often makes no visible changes to the text but can prompt web browsers to use a more appropriate font or screen readers to use a particular kind of pronunciation and so on. See § Rationale for more information.

Syntax and usage

{{lang|language tag|text}}

The language tag should consist of an ISO 639 language code. The template supports properly formatted IETF language tags using subtags that identify the language's script, region, and/or variant. The ISO 639 language code is a two- or three-letter abbreviation, in lowercase, of the language's name. French, for example, has the code fr:

She said: "{{lang|fr|Je suis française.}}" → She said: "Je suis française."

Because all languages represented by two-letter codes in ISO 639-1 can also be represented by their three-letter equivalents in ISO 639-2 and above, it is recommended to use the shortest language tag possible that sufficiently describes the target language.^[1] So while French could be represented by 639‑2's fra code, use the 639‑1 code fr instead. Likewise, script, region, and variant information should be included only when they provide a necessary distinction. For an up-to-date list of available language, script, region, and variant codes, please refer to the IANA's language subtag registry.

By default, this template will place articles into the relevant subcategory of Category:Articles containing non-English-language text. To suppress this – e.g. when using {{lang}} within a wikilink or the title parameter of a citation – add the parameter |nocat=true.

Formatting

Automatic italics

{{lang}} automatically applies italic styling when the text in {{{2}}} is written entirely in the Latn script (the Latin alphabet and its extensions), either when that is the default encoding for the language or when it is triggered by a xx-Latn language code:: {{lang|fr|Je suis française.}} → Je suis française.; ''{{lang|fr|Je suis française.}}'' → Je suis française. – external markup is ignored; {{lang|he-Latn|la`az}} ({{lang|he|לעז}}) → la`az (לעז); ''{{lang|he-Latn|la`az}}'' (''{{lang|he|לעז}}'') → la`az (לעז) – external markup is ignored around the he-Latn text, but will incorrectly italicize the Hebrew-character material.

When Latn script should not be italicized, there are multiple approaches:

|italic=no – renders {{{2}}} in upright font; italic markup around the template is ignored; italic markup inside the template causes an error message:: {{lang|fr|Je suis française.|italic=no}} → Je suis française.; ''{{lang|fr|Je suis française.|italic=no}}'' → Je suis française.; ''{{lang|fr|Je suis ''française''.|italic=no}}'' → [Je suis française.] Error: {{Lang}}: text has italic markup (help) – italic markup in conflict with |italic=no
|italic=unset – disables template-provided styling; {{{2}}} is styled according to external or internal wiki markup:: {{lang|fr|Je suis française.|italic=unset}} → Je suis française.; ''{{lang|fr|Je suis française.|italic=unset}}'' → Je suis française.; {{lang|fr|''Je suis'' English.|italic=unset}} → Je suis English.
{{noitalic}} can also be used:: {{lang|fr|Je suis {{noitalic|English}}.}} → Je suis English.

Right-to-left languages

To embed a string of right-to-left text (such as Arabic or Hebrew) within the usual left-to-right context, |rtl=yes should be added to correctly communicate writing direction. For convenience, the {{rtl-lang}} template accomplishes the same result by automatically including |rtl=yes. To markup a whole paragraph of right-to-left text, {{rtl-para}} should be used instead.

Any of these approaches will wrap the text in a container with the dir="rtl" attribute. In order to ensure correct rendering in browsers that do not fully support Wikipedia:HTML5 bidirectional isolation, a left-to-right mark is also added to the end of the text (see the W3C for details).

Note that text direction does not need to be specified when using the {{lang-xx}} templates, as this is implied by the template's language. Therefore there is no {{rtl-lang-ar}}, only {{lang-ar}}.

Parameters

lang supported parameters
parameter	definition	yields to	alias
`code`	IETF language tag for the content in `text`	–	`{{{1}}}`
`text`	non-English text	–	`{{{2}}}`
`rtl`	`yes` indicates that the writing system used for the content in `text` is right-to-left; accepted values are: `no` (default), `yes`	IETF script subtag in `code` (if provided)
`italic`	italic= parameter operation"; accepted values are: `yes`, `no`, `unset`, `invert`, `default`	–	`italics`,`i`
`size`	specifies font size of the content in `text`; use a value suitable for use with the CSS `font-size` property; this should almost always be a relative value supplied in `%` or `em` units, not a fixed `px` value.	–
`nocat`	inhibits automatic categorization; mirror version of `cat`; accepted values are: `yes`, `y`, `true`, `t`, `on`, `1`	–
`cat`	inhibits automatic categorization; mirror version of `nocat`; accepted values are: `no`, `n`, `false`, `f`, `off`, `0`	–

italic= parameter operation
italic= value	description	example code	result	html markup
parameter not present; parameter present, not set; invalid value	module applies style from: auto-italics or script subtag `latn`; else inherits from external markup; invalid values treated as default	`{{lang\|ru\|тундра}}`	тундра	`<span title="Russian-language text"><span lang="ru">тундра</span></span>`
		`{{lang\|ru\|tûndra}}`	tûndra	ru-latn.
		`{{lang\|fr\|toundra}}`	toundra	`<span title="French-language text"><i lang="fr">toundra</i></span>`
		`{{lang\|ru-latn\|tûndra}}`	tûndra	`<span title="Russian-language text"><i lang="ru-Latn">tûndra</i></span>`
`default`		`{{lang\|ru\|тундра\|italic=default}}`	тундра	`<span title="Russian-language text"><span lang="ru">тундра</span></span>`
		`{{lang\|fr\|toundra\|italic=default}}`	toundra	`<span title="French-language text"><i lang="fr">toundra</i></span>`
		`{{lang\|ru-latn\|tûndra\|italic=default}}`	tûndra	`<span title="Russian-language text"><i lang="ru-Latn">tûndra</i></span>`
`no`	module applies upright style; overrides auto-italics overrides script subtag `latn`; overrides external markup	`{{lang\|ru\|тундра\|italic=no}}`	тундра	`<span title="Russian-language text"><span lang="ru" style="font-style: normal;">тундра</span></span>`
		`{{lang\|fr\|toundra\|italic=no}}`	toundra	`<span title="French-language text"><span lang="fr" style="font-style: normal;">toundra</span></span>`
		`{{lang\|ru-latn\|tûndra\|italic=no}}`	tûndra	`<span title="Russian-language text"><span lang="ru-Latn" style="font-style: normal;">tûndra</span></span>`
		`''{{lang\|fr\|toundra\|italic=no}}''`	toundra	`''<span title="French-language text"><span lang="fr" style="font-style: normal;">toundra</span></span>''`
`yes`	module applies italic style; ignores auto-italics; ignores script subtag `latn`	`{{lang\|ru\|тундра\|italic=yes}}`	тундра	`<span title="Russian-language text"><i lang="ru">тундра</i></span>`
`yes`		`{{lang\|ru-latn\|tûndra\|italic=yes}}`	tûndra	`<span title="Russian-language text"><i lang="ru-Latn">tûndra</i></span>`
`unset`	module applies no style; inherits style from external markup; disables auto-italics overrides script subtag `latn`;	`{{lang\|ru\|тундра\|italic=unset}}`	тундра	`<span title="Russian-language text"><span lang="ru">тундра</span></span>`
		`''{{lang\|ru\|тундра\|italic=unset}}''`	тундра	`''<span title="Russian-language text"><span lang="ru">тундра</span></span>''`
		`{{lang\|ru-latn\|tûndra\|italic=unset}}`	tûndra	`<span title="Russian-language text"><span lang="ru-Latn">tûndra</span></span>`
		`''{{lang\|ru-latn\|tûndra\|italic=unset}}''`	tûndra	`''<span title="Russian-language text"><span lang="ru-Latn">tûndra</span></span>''`
`invert`	module applies no style; inverts style in internal markup; disables auto-italics overrides script subtag `latn`;	`{{lang\|ru\|тундра\|italic=invert}}`	тундра	`<span title="Russian-language text"><span lang="ru">''тундра''</span></span>`
		`{{lang\|ru\|''тундра''\|italic=invert}}`	тундра	`<span title="Russian-language text"><span lang="ru">тундра</span></span>`
		`{{lang\|ru-latn\|tûndra\|italic=invert}}`	tûndra	`<span title="Russian-language text"><span lang="ru-Latn">''tûndra''</span></span>`
		`{{lang\|ru-latn\|''tûndra''\|italic=invert}}`	tûndra	`<span title="Russian-language text"><span lang="ru-Latn">tûndra</span></span>`

compare |italic=invert to |italic=unset:

{{Lang|de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}

... ein neues Opernprojekt in Angriff: Das Käthchen von Heilbronn, nach Heinrich von Kleists gleichnamigem Drama.

{{Lang|de|''... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.''|italic=unset}}

... ein neues Opernprojekt in Angriff: Das Käthchen von Heilbronn, nach Heinrich von Kleists gleichnamigem Drama.

the function selector parameter

{{lang}} uses the Lua function lang() Module:Lang. That module also supports all of the {{lang-??}} templates using the Lua functions lang_xx_inherit() and lang_xx_italic(). The module has other functions that may be useful. The function selector parameter |fn= tells module:lang which function to execute. The available functions are:

is_ietf_tag – returns true if the provided IETF language tag is valid; nil else
- {{lang|fn=is_ietf_tag|nv}} →true←
- {{lang|fn=is_ietf_tag|xx}} →←
is_lang_name – returns true id the provided language name is valid; nil else
- {{lang|fn=is_lang_name|navajo}} →Lua error in Module:Lang/tag_from_name at line 112: attempt to index field '?' (a nil value).←
- {{lang|fn=is_lang_name|xxxxx}} →Lua error in Module:Lang/tag_from_name at line 112: attempt to index field '?' (a nil value).←
lang – the function that renders {{lang}}; listed here for completeness, this particular usage is more-or-less pointless
lang_xx_inherit – the function that renders {{lang-??}} template where the text is not italicized; can be used when a {{lang-??}} template, for example {{lang-aao}}, does not exist for a particular language:
- {{lang|fn=lang_xx_inherit|code=aao|Algerian Saharan Arabic text}} → Algerian Saharan Arabic: Algerian Saharan Arabic text
lang_xx_italic – the function that renders {{lang-??}} template where the text is italicized; can be used when a {{lang-??}} template, for example {{lang-svc}}, does not exist for a particular language:
- {{lang|fn=lang_xx_italic|code=svc|Vincentian Creole English text}} → Vincentian Creole English: Vincentian Creole English text
name_from_tag – returns the language name associated with the provided IETF language tag:
- {{lang|fn=name_from_tag|apa}} → Apache languages
tag_from_name – returns the ISO 639 language code (sometimes IETF language tag) associated with the provided language name:
- {{lang|fn=tag_from_name|havasupai}} → Lua error in Module:Lang/tag_from_name at line 112: attempt to index field '?' (a nil value).
transl – the function that renders {{transl}}; listed here for completeness, this particular usage is more-or-less pointless
- {{lang|fn=transl|ar|DIN|al-Ḫawārizmī}} → al-Ḫawārizmī

Indicating writing script

If necessary, an ISO 15924 script code can be appended to a language code to indicate the use of a specific script. For instance, Tajik (tg) is a language which can be found written in Arabic (Arab), Latin (Latn), and Cyrillic (Cyrl) scripts, making it necessary to always specify which script is in use. In such a case, taking care to preserve the script code's capitalization, we could end up with the following code (language tags in bold):

Tajik ({{rtl-lang|tg-Arab|تاجیکی}}, ''{{lang|tg-Latn|toçikī}}'', {{lang|tg-Cyrl|тоҷикӣ}})

Tajik (تاجیکی, toçikī, тоҷикӣ)

Many languages, however, are so commonly written in one particular script that specifying the script is unnecessary. Russian, for instance, is almost exclusively written in Cyrillic, so there is no need to specify ru-Cyrl, just as en-Latn would be unnecessary for English. The subtag registry contains up-to-date information on which languages have common script codes that should be "suppressed".

Transliteration

To mark a language which has been transliterated from one script into another, append the new script's code to the code of the original language. So if transliterating from Russian Cyrillic to a Latin script, the language tag on the transliteration would be ru-Latn. If the transliteration scheme is known, and listed as a "variant" in the subtag registry, it can be appended after any script and region codes. For example, Chinese transliterated into a Latin script using the pinyin system would be zh-Latn-pinyin. As a convenience for transliterating to Latin scripts, and to work around browser styling issues with some language and script combinations, {{transl}} may be used in place of {{lang}}:

Moscow ({{lang|ru|Москва́}}, {{transl|ru|Moskva}})

Moscow (Москва́, Moskva)

To specify a transliteration scheme, such as the ISO transliteration standard for Cyrillic, use {{transl|ru|ISO|Moskva}}.

Undetermined language

The {{lang}} template is not only used to specify the language of foreign words, but can also be used to specify a single symbol or character in a script, unrelated to any specific language. Many times the character or symbol is used in several languages, but when the article refers to the grapheme itself, the ISO 639‑2 language code und, for Undetermined language, should be used:

The {{lang|und-Hani|字}} Han character has 6 strokes.

The 字 Han character has 6 strokes.

Han characters are used in Chinese, Japanese, sometimes Korean, and formerly Vietnamese, and in this case the character is not used for any specific language. Note that the script code used is Hani, which specifies generic Han characters (Hanzi, Kanji, Hanja).

Compare {{script}} usage:

The {{script|Hani|字}} Han character has 6 strokes.

The 字 Han character has 6 strokes.

Indicating regional variant

When it is necessary to indicate region-specific language, an ISO 3166-1 alpha-2 country code, or UN M49 region code, should be added to the language tag, taking care to preserve capitalization. For example, Portuguese (pt) as used in Brazil (BR) could be represented as pt-BR, and Spanish as used in Latin America as es-419.

Additionally, language, script, and region codes can all appear in the same tag. For instance, the code zh-Hant-TW should be used for Chinese text written with Traditional Han characters, containing words or expressions specific to Taiwan:

Taiwan ({{lang|zh-Hant-TW|臺灣}}, {{transl|zh|Táiwān}})

Taiwan (臺灣, Táiwān)

Rationale

Wikipedia:Manual of Style/Text formatting § Foreign terms requires the use of {{lang}} instead of manual ''italics''. This is preferred for the following reasons:

Web browsers can use the information in such multilingual support templates to choose an appropriate font.
- This is great for CJK where a character can be given its language-specific shape but will fall back to another form if no appropriate font is found or if the preferred font lacks that character, for example because the language does not make use of that character: see wikipedia:Han unification § Examples of language-dependent glyphs and these comparison tables with a screenshot.
For accessibility – screen readers need language info to speak text in the correct language – and to satisfy Wikipedia accessibility guidelines.^[2]
For spell checkers and grammar checkers, to match the text to the dictionary and syntax of the correct language.
To help browsers choose appropriate quotation marks,^[3] and make decisions about hyphenation,^[3] ligatures,^[4] and spacing.^[3]
Users can apply styles to languages in their style sheets (useful for editors).
Search engines can use this information when indexing text.
Facilitates better data-scraping, parsing and re-use.
Useful for application developers who re-publish Wikipedia (also see Wikipedia:Manual of Style/Accessibility § Other languages).
Useful for research or compiling statistics about language use in Wikipedia.

Applying styles

Registered users can apply custom CSS styles to articles by placing style declarations in their user style sheet. The user style sheet can be created at Special:Mypage/common.css. For more information, see Help:User style. The following examples should work in most modern browsers, but not in Internet Explorer 8 or earlier, which lack support for attribute selectors.

To apply a specific font to all text marked as Russian of any script or region:

[lang|=ru] { font-family: fonteskaya; }
/*   or   */
:lang(ru) { font-family: fonteskaya; }

To apply a specific font to text marked simply as Russian:

[lang=ru] { font-family: fonteskaya; }

To apply a color to all text marked with any language:

[lang] { color: green; }

If a font name contains characters besides basic Latin letters or hyphens, it is a good idea to enclose it in quotation marks because some such characters have special meanings (the most common case needing quotation marks is a multi-word font name with space characters). Quotation marks are also required for font families containing generic-family keywords ('inherit', 'serif', 'sans-serif', 'monospace', 'fantasy', and 'cursive'). See the W3C for more details.

You can combine this with font imports in your user stylesheet, for example, to show all German text in Fraktur and all Urdu in Noto Nastaliq Urdu Regular:

@import url(https://fonts.googleapis.com/css?family=UnifrakturMaguntia);
@import url(http://fonts.googleapis.com/earlyaccess/notonastaliqurdudraft.css);

:lang(de) {
   font-family: UnifrakturMaguntia;
   font-style: normal;
   font-weight: normal;
}

:lang(ur) {
    font-family: "Noto Nastaliq Urdu Regular", "Noto Nastaliq Urdu";
}

then the following wikitext will look like the image below:

Victor jagt zwölf Boxkämpfer quer über den Sylter Deich

{{lang|de-Latf|Victor jagt zwölf Boxkämpfer quer über den Sylter Deich}}

ٹھنڈ میں، ایک قحط زدہ گاؤں سے گزرتے وقت ایک چڑچڑے، بااثر و فارغ شخص کو بعض جل پری نما اژدہے نظر آئے۔

{{lang|ur|ٹھنڈ میں، ایک قحط زدہ گاؤں سے گزرتے وقت ایک چڑچڑے، بااثر و فارغ شخص کو بعض جل پری نما اژدہے نظر آئے۔}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.

TemplateData for Lang

Indicate that a given span of text belongs to a particular language. Allows browsers to correctly present and pronounce foreign languages.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Language tag	`1` `code`	A language tag, or an ISO 639 language code. Example fr	String	required
Text	`2` `text`	The text belonging to the language specified. Example Je suis française.	String	required
Right to left	`rtl`	Indicates that the language should be displayed from right to left. Default no Example yes	String	optional
Italicize	`italic` `italics`	Italicizes the text Default yes Example no	Boolean	optional
Font-size	`size`	sets font-size Example 120%, 1.2em	Unknown	optional
nocat	`nocat`	no description	Unknown	optional