Template:Lang/doc

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.

Template:COinS safe

This is a documentation subpage for Template:Lang.
It contains usage information, categories and other content that is not part of the original page.

This template uses Lua:

Module:Lang

Template:Language templates

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

Template:In5{{lang|language tag|text}}

The language tag should consist of an ISO-639 language code. See the list of ISO 639-1 codes for two-letter codes; if you don't find the language you seek, then refer to the list of ISO 639-3 codes.

The template also 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 ISO 639-2's fra code, use the ISO 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 |cat=no.

Formatting

Automatic italics

Template:Tld 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 codeTemplate:Colon

{{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}}'' (Template:!mxt) → la'az (Template:!mxt) – 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 approachesTemplate:Colon |italic=no – renders {{{2}}} in upright font; italic markup around the template is ignored; italic markup inside the template causes an error messageTemplate:Colon

{{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 markupTemplate:Colon

{{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 usedTemplate:Colon

{{lang|fr|Je suis {{noitalic|English}}.}} → Je suis Template:Noitalic.

Language-specific templates

There are language-specific versions of this template, such as {{lang-fr}} and {{lang-ru}}, which are intended to be used the first time a language appears in an article. These templates will print the language's name and, when appropriate, italicize their content:

A '''kremlin''' ({{lang-ru|кремль}}, 'castle') is a major fortified central complex ... → A kremlin (Template:Lang-ru, 'castle') is a major fortified central complex ...

While Template:Tnull templates output text in italics for languages with Latin-based scripts, if plain text is required, such as for proper names, |italic=no or {{noitalic}} may be used:

the border town of Ventimiglia ({{lang-fr|Vintimille}}) → the border town of Ventimiglia (French: Vintimille)
the border town of Ventimiglia ({{lang-fr|italic=no|Vintimille}}) → the border town of Ventimiglia (French: Vintimille)
the border town of Ventimiglia ({{lang-fr|{{noitalic|Vintimille}}}}) → the border town of Ventimiglia (French: Template:Noitalic)

When formatting foreign-language text to match style guidelines, it is best to exclude the styling markup from the template, so that any extraneous markup which is not from the foreign language does not receive incorrect metadata for that language. This includes: English-language quotation marks around titles of works in languages that use other quotation character glyphs; italicization of titles in languages which do not use that convention; and emphasis that is not found (in one style or another) in the original foreign text; among other cases. If in doubt, put such markup outside the template when possible.

Proto languages

{{lang|cel-x-proto|kal-}} → *kal-
{{lang|cel-x-proto|kal-|proto=no}} → kal-
Lua error: expandTemplate: template "Template:lang-cel-x-proto" does not exist.
Lua error: expandTemplate: template "Template:lang-cel-x-proto" does not exist.
{{lang|en|accidently}} → accidently
{{lang|en|accidently|proto=yes}} → *accidently

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. To mark 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 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 Template:Tnull templates, as this is implied by the template's language.

Parameters

Template:Lang-x/doc/parameters

the function selector parameter

{{lang}} uses the Lua function lang() Module:Lang. That module also supports all of the Template:Tnull 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 if the provided language name is valid; nil else
- {{lang|fn=is_lang_name|navajo}} →true←
- {{lang|fn=is_lang_name|xxxxx}} →←
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 Template:Tnull template where the text is not italicized; can be used when a Template:Tnull 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 Template:Tnull template where the text is italicized; can be used when a Template:Tnull 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}} → yuf-x-hav
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 ({{lang|tg-Arab|rtl=yes|تاجیکی}}, {{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, {{transliteration}} may be used in place of {{lang}}:

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

To specify a transliteration scheme, such as the ISO transliteration standard for Cyrillic, use {{transliteration|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 Chinese character {{lang|und-Hani|字}} has 6 strokes.

The Chinese character 字 has 6 strokes.

Chinese characters (Template:Aka Han characters) have been used used to write Chinese, Japanese, Korean, Vietnamese, and numerous other languages. In this case the character does not represent a use specific to any language in particular. Note that the script code used is Hani, which specifies Chinese characters generally, as opposed to Hant and Hans for traditional or simplified characters respectively.

Compare the use of {{script}}:

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

The Chinese character Template:Script has 6 strokes.

Languages with no code

The code mis, for "Miscellaneous", to indicate any language not listed in ISO-639.

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|臺灣}}, {{transliteration|zh|Táiwān}})

Taiwan (臺灣, Táiwān)

Private-use language tags

This template supports various private-use IETF language tags. Private-use tags contain the -x- singleton and are used by the template to identify languages that are different, for one reason or another, from the base language identified by the ISO 639 language tag. Script error: No such module "Lang/documentor tool".

Links

If the {{lang}} template will have to be combined with links one might be tempted to move the {{lang}} template into the link so that it would only frame the link's text label, not the syntax elements of the links or other stylistic elements of some types of links. However, this does not work. The {{lang}} will have to wrap the entire link, regardless of whether it is an internal or external link, or a link provided through an {{ill}} interwiki link template:

Works:

{{lang|en|[[Book of hours]]}} → Book of hours
{{lang|de|[[Book of hours|Stundenbuch]]}} → Stundenbuch
{{lang|he-LA|{{ill|Machsor Lipsiae|de}}}} → Template:Ill

Does not work:

[[{{lang|en|Book of hours}}]] → [[Book of hours]] (never works)
[[Book of hours|{{lang|de|Stundenbuch}}]] → Stundenbuch (does not work in article space, works on talk and some other types of pages)
{{ill|Machsor Lipsiae|de|lt={{lang|he-LA|Machsor Lipsiae}}}} → Template:Ill (does not work in article space, works on talk and some other types of pages)

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 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 prevent the page from showing up on the Wikipedia:Typo Team/moss/not English report, which flags articles needing translation.
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 reuse.
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.

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

Template:Wide image

Tracking categories

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Lang in articles based on its 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
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` `i`	Italicizes the text Default yes Example no	Boolean	optional
Font-size	`size`	sets font-size Example 120%, 1.2em	Unknown	optional
cat	`cat`	no description	Unknown	optional
nocat	`nocat`	no description	Unknown	optional

References

^ "Language tags in HTML and XML" at World Wide Web Consortium
^ Heilmann, Chris (13 Mar 2008). "Yahoo! search results now with natural language support". Yahoo! Developer Network Blog. Archived from the original on 25 Jan 2009. Retrieved 28 Feb 2015.
^ ^a ^b ^c Ishida, Richard (18 November 2014). "Why use the language attribute?". World Wide Web Consortium. Retrieved 1 Mar 2015.
^ "6.4 Ligatures: the font-variant-ligatures property". CSS Fonts Module Level 3 W3C Candidate Recommendation 3 October 2013.

External links

[1] "Language tags in HTML and XML" at World Wide Web Consortium

[2] Heilmann, Chris (13 Mar 2008). "Yahoo! search results now with natural language support". Yahoo! Developer Network Blog. Archived from the original on 25 Jan 2009. Retrieved 28 Feb 2015.

[qa-lang-why-3] Ishida, Richard (18 November 2014). "Why use the language attribute?". World Wide Web Consortium. Retrieved 1 Mar 2015.

[4] "6.4 Ligatures: the font-variant-ligatures property". CSS Fonts Module Level 3 W3C Candidate Recommendation 3 October 2013.

[1]

[2]

[3]

[4]