Difference between revisions of "Template:Lang/doc"
imported>Quoth-22 m (CE) |
imported>Fredlesaltique (Fixed link error) |
||
| (111 intermediate revisions by 54 users not shown) | |||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | {{High- | + | {{High-use}} |
| − | {{COinS safe|n| | + | {{COinS safe|n}} |
| − | 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 | + | {{Lua|Module:Lang}} |
| + | {{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 {{section link||Rationale}} for more information. | ||
== Syntax and usage == | == Syntax and usage == | ||
| − | + | {{in5}}{{tlx|lang|{{var|language tag}}|{{var|text}}}} | |
| − | The {{var|language tag}} should consist of an [[List of ISO 639 codes| | + | The {{var|language tag}} should consist of an [[ISO-639]] language code (click [[List of ISO 639-1 codes|'''here''']] for list of most codes). The template also supports properly formatted [[IETF language tag]]s 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 <code>fr</code>: |
| − | * <code><nowiki>She said: " | + | * <code><nowiki>She said: "{{lang|fr|Je suis française.}}"</nowiki></code> → She said: "{{lang|fr|Je suis française.}}" |
| − | |||
| − | Because all languages represented by two-letter codes in [[ISO | + | 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.<ref>[https://www.w3.org/International/articles/language-tags/index.en "Language tags in HTML and XML"] at [[World Wide Web Consortium]]</ref> So while French could be represented by 639‑2's <code>fra</code> code, use the 639‑1 code <code>fr</code> 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 [[Internet Assigned Numbers Authority|IANA]]'s [http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry language subtag registry]. |
| − | By default, this template will place articles into the relevant subcategory of {{ | + | By default, this template will place articles into the relevant subcategory of {{category link|Articles containing non-English-language text}}. To suppress this – e.g. when using {{tlf|lang}} within a [[Help:Link#Wikilinks|wikilink]] or the ''title'' parameter of a citation – add the parameter {{para|nocat|true}}. |
=== Formatting === | === Formatting === | ||
| + | ==== Automatic italics ==== | ||
| + | {{tld|lang}} automatically applies italic styling <span style="font-weight: normal;">when the text in <code><nowiki>{{{2}}}</nowiki></code> is written entirely in the <code>Latn</code> script (the Latin alphabet and its extensions), either when that is the default encoding for the language or when it is triggered by a <code>{{var|xx}}-Latn</code> language code{{colon}}</span> | ||
| + | * <code><nowiki>{{lang|fr|Je suis française.}}</nowiki></code> → {{lang|fr|Je suis française.}} | ||
| + | * <code><nowiki>''{{lang|fr|Je suis française.}}''</nowiki></code> → ''{{lang|fr|Je suis française.}}'' – external markup is ignored | ||
| + | * <code><nowiki>{{lang|he-Latn|la`az}} ({{lang|he|לעז}})</nowiki></code> → {{lang|he-Latn|la`az}} ({{lang|he|לעז}}) | ||
| + | * <code><nowiki>''{{lang|he-Latn|la`az}}''</nowiki> ({{!mxt|<nowiki>''{{lang|he|לעז}}''</nowiki>}})</code> → ''{{lang|he-Latn|la`az}}'' ({{!mxt|''{{lang|he|לעז}}''}}) – external markup is ignored around the <code>he-Latn</code> text, but will incorrectly italicize the Hebrew-character material. | ||
| + | When <code>Latn</code> script should not be italicized, there are multiple approaches{{colon}} | ||
| + | {{para|italic|no}} <span style="font-weight: normal;">– renders <code><nowiki>{{{2}}}</nowiki></code> in upright font; italic markup around the template is ignored; italic markup inside the template causes an error message{{colon}}</span> | ||
| + | * <code><nowiki>{{lang|fr|Je suis française.|italic=no}}</nowiki></code> → {{lang|fr|Je suis française.|italic=no}} | ||
| + | * <code><nowiki>''{{lang|fr|Je suis française.|italic=no}}''</nowiki></code> → ''{{lang|fr|Je suis française.|italic=no}}'' | ||
| + | * <code><nowiki>''{{lang|fr|Je suis ''française''.|italic=no}}''</nowiki></code> → ''{{lang|fr|Je suis ''française''.|italic=no|nocat=yes}}'' – italic markup in conflict with {{para|italic|no}} | ||
| + | |||
| + | {{para|italic|unset}} <span style="font-weight: normal;">– disables template-provided styling; <code><nowiki>{{{2}}}</nowiki></code> is styled according to external or internal wiki markup{{colon}}</span> | ||
| + | * <code><nowiki>{{lang|fr|Je suis française.|italic=unset}}</nowiki></code> → {{lang|fr|Je suis française.|italic=unset}} | ||
| + | * <code><nowiki>''{{lang|fr|Je suis française.|italic=unset}}''</nowiki></code> → ''{{lang|fr|Je suis française.|italic=unset}}'' | ||
| + | * <code><nowiki>{{lang|fr|''Je suis'' English.|italic=unset}}</nowiki></code> → {{lang|fr|''Je suis'' English.|italic=unset}} | ||
| + | |||
| + | {{tlx|noitalic}} <span style="font-weight: normal;">can also be used{{colon}}</span> | ||
| + | * <code><nowiki>{{lang|fr|Je suis {{noitalic|English}}.}}</nowiki></code> → {{lang|fr|Je suis {{noitalic|English}}.}} | ||
| + | {{hatnote|{{crossreference|See table "[[#italic parameter|lang {{!}}italic{{=}} parameter operation]]".}}}} | ||
| + | |||
| + | ==== Language-specific templates ==== | ||
There are language-specific versions of this template, such as {{tl|lang-fr}} and {{tl|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: | There are language-specific versions of this template, such as {{tl|lang-fr}} and {{tl|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: | ||
| − | * <code><nowiki>A '''kremlin''' ({{lang-ru|кремль}}, | + | * <code><nowiki>A '''kremlin''' ({{lang-ru|кремль}}, 'castle') is a major fortified central complex ...</nowiki></code> → A '''kremlin''' ({{lang-ru|кремль}}, 'castle') is a major fortified central complex ... |
| − | |||
| − | While {{ | + | While {{tnull|lang-{{var|xx}}}} templates output text in italics for languages with Latin-based scripts, if plain text is required, such as for proper names, {{para|italic|no}} or {{tlx|noitalic}} may be used: |
| − | * <code> | + | * <code><nowiki>the border town of Ventimiglia ({{lang-fr|Vintimille}})</nowiki></code> → the border town of Ventimiglia ({{lang-fr|Vintimille}}) |
| − | + | * <code><nowiki>the border town of Ventimiglia ({{lang-fr|italic=no|Vintimille}})</nowiki></code> → the border town of Ventimiglia ({{lang-fr|italic=no|Vintimille}}) | |
| + | * <code><nowiki>the border town of Ventimiglia ({{lang-fr|{{noitalic|Vintimille}}}})</nowiki></code> → the border town of Ventimiglia ({{lang-fr|{{noitalic|Vintimille}}}}) | ||
| − | 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: | + | 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. |
| − | + | {{See also|Wikipedia:Manual of Style/Text formatting#Foreign terms}} | |
| − | |||
| − | + | === Right-to-left languages === | |
| − | + | To embed a string of right-to-left text (such as [[Arabic]] or [[Hebrew language|Hebrew]]) within the usual left-to-right context, {{para|rtl|yes}} should be added to correctly communicate writing direction. For convenience, the {{tl|rtl-lang}} template accomplishes the same result by automatically including {{para|rtl|yes}}. To markup a whole paragraph of right-to-left text, {{tl|rtl-para}} should be used instead. | |
| − | + | Any of these approaches will wrap the text in a container with the <code>dir="rtl"</code> attribute. In order to ensure correct rendering in browsers that do not fully support [[HTML5]] [[bidirectional text|bidirectional isolation]], a [[left-to-right mark]] is also added to the end of the text (see the [http://www.w3.org/International/articles/inline-bidi-markup W3C] for details). | |
| − | + | Note that text direction does not need to be specified when using the {{tnull|lang-{{var|xx}}}} templates, as this is implied by the template's language. Therefore there is no {{tlf|rtl-lang-ar}}, only {{tl|lang-ar}}. | |
| − | + | == Parameters == | |
| + | {{#lst:Template:Lang-x/doc/parameters|lang_parameters}} | ||
| + | ===the function selector parameter=== | ||
| + | {{tlx|lang}} uses the Lua function <code>lang()</code> [[Module:Lang]]. That module also supports all of the {{tnull|lang-??}} templates using the Lua functions <code>lang_xx_inherit()</code> and <code>lang_xx_italic()</code>. The module has other functions that may be useful. The function selector parameter {{para|fn}} tells module:lang which function to execute. The available functions are: | ||
| + | *<code>is_ietf_tag</code> – returns <code>true</code> if the provided [[IETF language tag]] is valid; nil else | ||
| + | **<code><nowiki>{{lang|fn=is_ietf_tag|nv}}</nowiki></code> →{{lang|fn=is_ietf_tag|nv}}← | ||
| + | **<code><nowiki>{{lang|fn=is_ietf_tag|xx}}</nowiki></code> →{{lang|fn=is_ietf_tag|xx}}← | ||
| + | *<code>is_lang_name</code> – returns <code>true</code> if the provided language name is valid; nil else | ||
| + | **<code><nowiki>{{lang|fn=is_lang_name|navajo}}</nowiki></code> →{{lang|fn=is_lang_name|navajo}}← | ||
| + | **<code><nowiki>{{lang|fn=is_lang_name|xxxxx}}</nowiki></code> →{{lang|fn=is_lang_name|xxxxx}}← | ||
| + | *<code>lang</code> – the function that renders {{tlx|lang}}; listed here for completeness, this particular usage is more-or-less pointless | ||
| + | *<code>lang_xx_inherit</code> – the function that renders {{tnull|lang-??}} template where the text is not italicized; can be used when a {{tnull|lang-??}} template, for example {{tlx|lang-aao}}, does not exist for a particular language: | ||
| + | **<code><nowiki>{{lang|fn=lang_xx_inherit|code=aao|Algerian Saharan Arabic text}}</nowiki></code> → {{lang|fn=lang_xx_inherit|code=aao|Algerian Saharan Arabic text}} | ||
| + | *<code>lang_xx_italic</code> – the function that renders {{tnull|lang-??}} template where the text is italicized; can be used when a {{tnull|lang-??}} template, for example {{tlx|lang-svc}}, does not exist for a particular language: | ||
| + | **<code><nowiki>{{lang|fn=lang_xx_italic|code=svc|Vincentian Creole English text}}</nowiki></code> → {{lang|fn=lang_xx_italic|code=svc|Vincentian Creole English text}} | ||
| + | *<code>name_from_tag</code> – returns the language name associated with the provided IETF language tag: | ||
| + | **<code><nowiki>{{lang|fn=name_from_tag|apa}}</nowiki></code> → {{lang|fn=name_from_tag|apa}} | ||
| + | *<code>tag_from_name</code> – returns the ISO 639 language code (sometimes IETF language tag) associated with the provided language name: | ||
| + | **<code><nowiki>{{lang|fn=tag_from_name|havasupai}}</nowiki></code> → {{lang|fn=tag_from_name|havasupai}} | ||
| + | *<code>transl</code> – the function that renders {{tlx|transl}}; listed here for completeness, this particular usage is more-or-less pointless | ||
| + | **<code><nowiki>{{lang|fn=transl|ar|DIN|al-Ḫawārizmī}}</nowiki></code> → {{lang|fn=transl|ar|DIN|al-Ḫawārizmī}} | ||
== Indicating writing script == | == Indicating writing script == | ||
| Line 51: | Line 94: | ||
: Tajik ({{rtl-lang|tg-Arab|تاجیکی}}, ''{{lang|tg-Latn|toçikī}}'', {{lang|tg-Cyrl|тоҷикӣ}}) | : Tajik ({{rtl-lang|tg-Arab|تاجیکی}}, ''{{lang|tg-Latn|toçikī}}'', {{lang|tg-Cyrl|тоҷикӣ}}) | ||
| − | Many languages, however, are so commonly written in one particular script that specifying the script is unnecessary. | + | 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 <code>ru-Cyrl</code>, just as <code>en-Latn</code> would be unnecessary for English. The [http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry subtag registry] contains up-to-date information on which languages have common script codes that should be "suppressed". |
=== Transliteration === | === Transliteration === | ||
| − | To mark a language which has been [[transliteration|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 <code>ru-Latn</code>. As a convenience for transliterating to Latin scripts, and to work around browser styling issues with some language and script combinations, {{tl|transl}} | + | To mark a language which has been [[transliteration|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 <code>ru-Latn</code>. If the transliteration scheme is known, and listed as a "variant" in the [http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry 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 <code>zh-Latn-pinyin</code>. As a convenience for transliterating to Latin scripts, and to work around browser styling issues with some language and script combinations, {{tl|transl}} may be used in place of {{tlf|lang}}: |
| − | * <code><nowiki>Moscow ({{lang|ru|Москва́}}, | + | * <code><nowiki>Moscow ({{lang|ru|Москва́}}, {{transl|ru|Moskva}})</nowiki></code> |
| − | : Moscow ({{lang|ru|Москва́}}, | + | : Moscow ({{lang|ru|Москва́}}, {{transl|ru|Moskva}}) |
To specify a transliteration scheme, such as the [[ISO 9|ISO transliteration standard for Cyrillic]], use {{tlc|transl|ru|ISO|Moskva}}. | To specify a transliteration scheme, such as the [[ISO 9|ISO transliteration standard for Cyrillic]], use {{tlc|transl|ru|ISO|Moskva}}. | ||
| Line 78: | Line 121: | ||
== Indicating regional variant == | == Indicating regional variant == | ||
| − | When it is necessary to indicate region-specific language, an [[ISO 3166-1 alpha-2]] country code, or [[UN | + | 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 (<code>pt</code>) as used in Brazil (<code>BR</code>) could be represented as <code>pt-BR</code>, and Spanish as used in Latin America as <code>es-419</code>. |
| − | Additionally, language, script, and region codes can all appear in the same tag. For instance, the code <code>zh-Hant-TW</code> should be used for | + | Additionally, language, script, and region codes can all appear in the same tag. For instance, the code <code>zh-Hant-TW</code> should be used for Chinese text written with [[Traditional Chinese characters|Traditional Han characters]], containing words or expressions specific to [[Taiwan]]: |
| − | * <code><nowiki>Taiwan ({{lang|zh-Hant-TW|臺灣}}, | + | * <code><nowiki>Taiwan ({{lang|zh-Hant-TW|臺灣}}, {{transl|zh|Táiwān}})</nowiki></code> |
| − | : Taiwan ({{lang|zh-Hant-TW|臺灣}}, | + | : Taiwan ({{lang|zh-Hant-TW|臺灣}}, {{transl|zh|Táiwān}}) |
== Rationale == | == Rationale == | ||
| − | * [[WWW|Web]] [[Web browser|browsers]] can use the information in such [[:Category:multilingual support templates|multilingual support templates]] to choose an appropriate font. | + | {{section link|Wikipedia:Manual of Style/Text formatting|Foreign terms}} requires the use of {{tl|lang}} instead of manual <nowiki>''italics''</nowiki>. This is preferred for the following reasons: |
| − | ** This is great for [[CJK characters|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 {{section link|Han unification|Examples of language dependent | + | |
| − | * For [[web accessibility|accessibility]] – [[screen reader]]s need language info to speak text in the correct language – and to satisfy [[Wikipedia:Accessibility#Text|Wikipedia accessibility guidelines]].<ref>{{cite web|url=https://developer.yahoo.com/blogs/ydn/yahoo-search-results-now-natural-language-support-7318.html|title=Yahoo! search results now with natural language support|date=13 Mar 2008|first= Chris |last= Heilmann|work=[[Yahoo! Developer Network]] Blog|accessdate=28 Feb 2015|archiveurl= | + | * [[WWW|Web]] [[Web browser|browsers]] can use the information in such [[:Category:Wikipedia multilingual support templates|multilingual support templates]] to choose an appropriate font. |
| − | * For [[spell checker]]s and grammar checkers. | + | ** This is great for [[CJK characters|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 {{section link|Han unification|Examples of language-dependent glyphs}} and [[User:Wikipeditor/CJK|these comparison tables with a screenshot]]. |
| − | * To help browsers choose appropriate [[quotation mark]]s,<ref name="qa-lang-why">{{cite web|url=http://www.w3.org/International/questions/qa-lang-why|title=Why use the language attribute?|date=18 November 2014|first= Richard |last= Ishida | publisher=World Wide Web Consortium | issue=Previously by Deborah Cawkwell, BBC World Service|accessdate=1 Mar 2015}}</ref> and make decisions about [[Hyphen|hyphenation]],<ref name="qa-lang-why"/> [[ | + | * For [[web accessibility|accessibility]] – [[screen reader]]s need language info to speak text in the correct language – and to satisfy [[Wikipedia:Accessibility#Text|Wikipedia accessibility guidelines]].<ref>{{cite web|url=https://developer.yahoo.com/blogs/ydn/yahoo-search-results-now-natural-language-support-7318.html|title=Yahoo! search results now with natural language support|date=13 Mar 2008|first= Chris |last= Heilmann|work=[[Yahoo! Developer Network]] Blog|accessdate=28 Feb 2015|archiveurl=https://web.archive.org/web/20090125024422/http://developer.yahoo.net/blog/archives/2008/03/yahoo_search_re.html|archivedate=25 Jan 2009|url-status=dead}}</ref> |
| − | * Users can apply styles to languages in their [[ | + | * For [[spell checker]]s and grammar checkers, to match the text to the dictionary and syntax of the correct language. |
| − | * [[Web search engine|Search engine]]s can use this information when [[ | + | * To help browsers choose appropriate [[quotation mark]]s,<ref name="qa-lang-why">{{cite web|url=http://www.w3.org/International/questions/qa-lang-why|title=Why use the language attribute?|date=18 November 2014|first= Richard |last= Ishida | publisher=World Wide Web Consortium | issue=Previously by Deborah Cawkwell, BBC World Service|accessdate=1 Mar 2015}}</ref> and make decisions about [[Hyphen|hyphenation]],<ref name="qa-lang-why"/> [[orthographic ligature|ligature]]s,<ref>{{cite web|url=http://www.w3.org/TR/css3-fonts/#font-variant-ligatures-prop|title=6.4 Ligatures: the font-variant-ligatures property|work=CSS Fonts Module Level 3 W3C Candidate Recommendation 3 October 2013}}</ref> and spacing.<ref name="qa-lang-why"/> |
| + | * Users can apply styles to languages in their [[style sheet (web development)|style sheet]]s (useful for editors). | ||
| + | * [[Web search engine|Search engine]]s can use this information when [[search engine indexing|indexing]] text. | ||
* Facilitates better data-scraping, parsing and re-use. | * Facilitates better data-scraping, parsing and re-use. | ||
* Useful for application developers who re-publish Wikipedia (also see {{section link|Wikipedia:Manual of Style/Accessibility|Other languages}}). | * Useful for application developers who re-publish Wikipedia (also see {{section link|Wikipedia:Manual of Style/Accessibility|Other languages}}). | ||
| Line 100: | Line 145: | ||
== Applying styles == | == Applying styles == | ||
| − | Registered users can apply custom [[Cascading Style Sheets|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 [[List of web browsers|modern browsers]] | + | Registered users can apply custom [[Cascading Style Sheets|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 [[List of web browsers|modern browsers]]. |
| − | To apply a specific font to all text marked as Russian: | + | To apply a specific font to all text marked as Russian of any script or region: |
<syntaxhighlight lang="css"> | <syntaxhighlight lang="css"> | ||
| − | + | [lang|=ru] { font-family: fonteskaya; } | |
| + | /* or */ | ||
| + | :lang(ru) { font-family: fonteskaya; } | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | To apply a | + | To apply a specific font to text marked simply as Russian: |
<syntaxhighlight lang="css"> | <syntaxhighlight lang="css"> | ||
| − | + | [lang=ru] { font-family: fonteskaya; } | |
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | To apply a color to all text marked with any language: | |
| + | |||
| + | <syntaxhighlight lang="css"> | ||
| + | [lang] { color: green; } | ||
| + | </syntaxhighlight> | ||
| + | |||
| + | 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 [http://www.w3.org/TR/CSS21/fonts.html#font-family-prop 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 fonts|Noto]] [[Nastaʿlīq script|Nastaliq]] Urdu Regular: | ||
| + | |||
| + | <syntaxhighlight lang="css"> | ||
| + | @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"; | ||
| + | } | ||
| + | |||
| + | </syntaxhighlight> | ||
| + | |||
| + | then the following wikitext will look like the image below: | ||
| + | |||
| + | <pre> | ||
| + | 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|ٹھنڈ میں، ایک قحط زدہ گاؤں سے گزرتے وقت ایک چڑچڑے، بااثر و فارغ شخص کو بعض جل پری نما اژدہے نظر آئے۔}} | ||
| + | </pre> | ||
| + | |||
| + | {{Wide image|Pangrams in DE and UR in Arial, UnifrakturMaguntia and Noto Nastaliq Urdu.png|1000px}} | ||
| + | |||
| + | == Tracking categories == | ||
| + | * {{Category link with count|Lang and lang-xx template errors}} | ||
| + | * {{Category link with count|Lang and lang-xx code promoted to ISO 639-1}} | ||
| + | * {{Category link with count|Lang and lang-xx using deprecated ISO 639 codes}} | ||
== TemplateData == | == TemplateData == | ||
| − | {{ | + | {{TemplateData header}} |
<templatedata> | <templatedata> | ||
{ | { | ||
| Line 128: | Line 218: | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "example": "fr" | + | "example": "fr", |
| + | "aliases": [ | ||
| + | "code" | ||
| + | ] | ||
}, | }, | ||
"2": { | "2": { | ||
| Line 135: | Line 228: | ||
"type": "string", | "type": "string", | ||
"required": true, | "required": true, | ||
| − | "example": "Je suis française." | + | "example": "Je suis française.", |
| + | "aliases": [ | ||
| + | "text" | ||
| + | ] | ||
}, | }, | ||
"rtl": { | "rtl": { | ||
| Line 141: | Line 237: | ||
"description": "Indicates that the language should be displayed from right to left.", | "description": "Indicates that the language should be displayed from right to left.", | ||
"example": "yes", | "example": "yes", | ||
| − | "type": "string" | + | "type": "string", |
| − | } | + | "default": "no" |
| + | }, | ||
| + | "italic": { | ||
| + | "aliases": [ | ||
| + | "italics" | ||
| + | ], | ||
| + | "label": "Italicize", | ||
| + | "description": "Italicizes the text", | ||
| + | "default": "yes", | ||
| + | "example": "no", | ||
| + | "type": "boolean" | ||
| + | }, | ||
| + | "size": { | ||
| + | "label": "Font-size", | ||
| + | "description": "sets font-size", | ||
| + | "example": "120%, 1.2em" | ||
| + | }, | ||
| + | "nocat": {} | ||
}, | }, | ||
"format": "inline" | "format": "inline" | ||
| Line 149: | Line 262: | ||
== See also == | == See also == | ||
| − | * {{tl| | + | * {{tl|Lang-x}} |
| − | * [[:Category: | + | * [[:Category:Wikipedia multilingual support templates]] |
| − | * [[ | + | * [[Lists of ISO 639 codes]] (language codes) |
** {{tl|ISO 639 name}} | ** {{tl|ISO 639 name}} | ||
* [[List of ISO 15924 codes]] (script codes) | * [[List of ISO 15924 codes]] (script codes) | ||
* [[List of ISO romanizations|List of ISO transliterations]] (transliteration codes) | * [[List of ISO romanizations|List of ISO transliterations]] (transliteration codes) | ||
| − | * {{tl| | + | * {{tl|cleanup lang}} (for articles which should use this template, but do not yet) |
| − | * {{tl|transl}} (for romanisation of languages not natively written in the Latin alphabet | + | * {{tl|transl}} (for romanisation of languages not natively written in the Latin alphabet) |
* {{tl|script}} (for specific characters) | * {{tl|script}} (for specific characters) | ||
| − | * | + | * {{tl|wikt-lang}} (to simultaneously tag text as a language and link to Wiktionary) |
| + | * {{tl|in lang}} (for visually marking external links to foreign-language content) | ||
| − | == | + | == References == |
| + | {{reflist}} | ||
| + | |||
| + | == External links == | ||
* [[World Wide Web Consortium|W3C]] | * [[World Wide Web Consortium|W3C]] | ||
** [http://www.w3.org/International/articles/language-tags/Overview.en.php Language tags in HTML and XML] – Overview | ** [http://www.w3.org/International/articles/language-tags/Overview.en.php Language tags in HTML and XML] – Overview | ||
| Line 168: | Line 285: | ||
* [[Internet Assigned Numbers Authority|IANA]] | * [[Internet Assigned Numbers Authority|IANA]] | ||
** [http://www.iana.org/assignments/language-subtag-registry IANA Language Subtag Registry] | ** [http://www.iana.org/assignments/language-subtag-registry IANA Language Subtag Registry] | ||
| − | ** [http://www.rfc-editor.org/rfc/rfc4646.txt Tags for Identifying Languages] (RFC 4646) | + | ** [http://www.rfc-editor.org/rfc/rfc4646.txt Tags for Identifying Languages] ({{IETF RFC|4646}}) |
| − | ** [http://www.rfc-editor.org/rfc/rfc4647.txt Matching of Language Tags] (RFC 4647) | + | ** [http://www.rfc-editor.org/rfc/rfc4647.txt Matching of Language Tags] ({{IETF RFC|4647}}) |
| − | ** [http://www.iana.org/assignments/language-tags Language tags] (obsolete per RFC 4646) | + | ** [http://www.iana.org/assignments/language-tags Language tags] (obsolete per {{IETF RFC|4646}}) |
* [[Mozilla Firefox]] | * [[Mozilla Firefox]] | ||
** [https://bugzilla.mozilla.org/show_bug.cgi?id=192636 Bug with script selection] | ** [https://bugzilla.mozilla.org/show_bug.cgi?id=192636 Bug with script selection] | ||
| − | + | <includeonly>{{Sandbox other|| | |
| − | + | [[Category:Wikipedia multilingual support templates]] | |
| − | + | [[Category:Templates that add a tracking category]] | |
| − | <includeonly>{{ | + | [[Category:Language tag handling templates]] |
| − | + | }}</includeonly> | |
| − | [[Category: | ||
| − | }}</includeonly | ||
| − | |||
Latest revision as of 07:03, 28 February 2021
| This is a documentation subpage for Template:Lang. It contains usage information, categories and other content that is not part of the original template page. |
| This template is used on approximately 264,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This template should not be used in citation templates such as Citation Style 1 and Citation Style 2, because it includes markup that will pollute the COinS metadata they produce; see Wikipedia:COinS. |
| This template uses Lua: |
| Language templates |
|---|
| Languages (ISO 639) |
|
| Wiktionary links |
|
| Other |
|
| Data |
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 Script error: No such module "Section link". for more information.
Contents
Syntax and usage
{{lang|language tag|text}}
The language tag should consist of an ISO-639 language code (click here for list of most 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 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 thehe-Latntext, 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.
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 (Russian: кремль, 'castle') is a major fortified central complex ...
While {{lang-xx}} 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: Vintimille)
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.
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 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
{{#lst:Template:Lang-x/doc/parameters|lang_parameters}}
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– returnstrueif 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– returnstrueif 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 pointlesslang_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}}→ 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 ({{rtl-lang|tg-Arab|تاجیکی}}, ''{{lang|tg-Latn|toçikī}}'', {{lang|tg-Cyrl|тоҷикӣ}})
- Tajik (Template:Rtl-lang, 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 (Москва́, Template:Transl)
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 Template:Script 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 (臺灣, Template:Transl)
Rationale
Script error: No such module "Section link". 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 Script error: No such module "Section link". 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 Script error: No such module "Section link".).
- 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|ٹھنڈ میں، ایک قحط زدہ گاؤں سے گزرتے وقت ایک چڑچڑے، بااثر و فارغ شخص کو بعض جل پری نما اژدہے نظر آئے۔}}
Tracking categories
- Category:Lang and lang-xx template errors (0)
- Category:Lang and lang-xx code promoted to ISO 639-1 (0)
- Category:Lang and lang-xx using deprecated ISO 639 codes (0)
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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Language tag | 1 code | A language tag, or an ISO 639 language code.
| String | required |
| Text | 2 text | The text belonging to the language specified.
| String | required |
| Right to left | rtl | Indicates that the language should be displayed from right to left.
| String | optional |
| Italicize | italic italics | Italicizes the text
| Boolean | optional |
| Font-size | size | sets font-size
| Unknown | optional |
| Nocat | nocat | no description | Unknown | optional |
See also
- {{Lang-x}}
- Category:Wikipedia multilingual support templates
- Lists of ISO 639 codes (language codes)
- {{ISO 639 name}}
- List of ISO 15924 codes (script codes)
- List of ISO transliterations (transliteration codes)
- {{cleanup lang}} (for articles which should use this template, but do not yet)
- {{transl}} (for romanisation of languages not natively written in the Latin alphabet)
- {{script}} (for specific characters)
- {{wikt-lang}} (to simultaneously tag text as a language and link to Wiktionary)
- {{in lang}} (for visually marking external links to foreign-language content)
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.
- ↑ 3.0 3.1 3.2 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
- W3C
- Language tags in HTML and XML – Overview
- Authoring HTML: Language declarations – Latest W3C Working Draft
- Understanding the New Language Tags
- FAQ: Styling using the lang attribute
- IANA
- Mozilla Firefox