View source for Template:Langx/doc

{{High-use}}
{{COinS safe|n}}
{{No subst}}
{{Documentation subpage}}
{{Lua|Module:Lang}}
{{Language templates}}

== Usage ==
This language template identifies non-English text. Both an [[IETF language tag]] and the non-English term or phrase are the only required parameters. The text is formatted according to recommendations in {{section link|Wikipedia:Manual of Style/Text formatting#Foreign terms}}; italics for languages that use the [[Latin alphabet]]<!-- Not the same thing as Romance languages and Latinate languages-->, normal for others.

The template should generally be placed after the English translation of the foreign term or phrase.

The parameter {{Para|links|no}} prevents the language name from being linked.

The parameter {{Para|translit}} allows for a [[romanization]] to be identified. This parameter is not supported by {{tld|langx|&lt;{{var|tag}}>|...}} templates for languages that are already written in Latin script.

The parameter {{Para|lit}} enables a literal translation (in English) to be given.

== Parameters ==
{| class="wikitable"
|+ Langx supported parameters
! style="width: 15%;" | Parameter
! Definition
! style="width: 10%;" | Yields to
! style="width: 12%;" | Alias
|-
| {{para|1}} || The [[IETF language tag]] for the content in {{para|text}} || – || {{para|code}}
|-
| {{para|text}} || The non-English text || – || {{para|2}}
|-
| {{para|translit}} || The Latin script transliteration of the content in {{para|text}} || – || {{para|3}}
|-
| {{para|translit-std}} || The standard used for the transliteration of the value of {{para|translit}}; accepted values are: <kbd>ISO</kbd>, <kbd>DIN</kbd>, <kbd>IAST</kbd>, <kbd>ALA</kbd>, <kbd>ALA-LC</kbd> || – ||
|-
| {{para|translit-script}} || The transliteration standard's script identifier || – ||
|-
| {{para|translation}} || The literal English translation or gloss of the content in {{para|text}} || – || {{para|lit}}, {{para|4}}
|-
| {{para|label}} || The label to be used instead of template-provided language label. May be wikilinked. Special keyword <kbd>none</kbd> causes the template to render without any labels (including transliteration and translation labels) || – ||
|-
| {{para|link}} || Links language name and static text associated with {{para|translit}} and {{para|translation}}. Defaults to <kbd>yes</kbd>. Accepted values are: <kbd>no</kbd>, <kbd>yes</kbd>; {{para|link|no}} does not unlink wikilinked labels set by {{para|label}} || – || {{para|links}}
|-
| {{para|proto}} || Accepted values are: <kbd>no</kbd> (default) or <kbd>yes</kbd> (default for private-use language tags with the <kbd>-x-proto</kbd> subtags); when <kbd>yes</kbd> (default or explicit), prefixes rendered text with an asterisk indicating 'unattested' || – || 
|-
| {{para|{{dcr|script}}}} || (Deprecated – include script subtag in {{para|1}}) IETF language script subtag; sometimes set by the template when the language of the content in {{para|text}} uses more than one writing system; always four alpha characters; a value of <kbd>Latn</kbd> <small>({{em|not}} "Latin"!)</small> forces italic rendering unless overridden by {{para|italic}}; overrides {{para|rtl}} || {{para|italic}} ||
|-
| {{para|{{dcr|region}}}} || (Deprecated – include region subtag in {{para|1}}) IETF language region subtag || – ||
|-
| {{para|{{dcr|variant}}}} || (Deprecated – include variant subtag in {{para|1}}) IETF language variant subtag || – ||
|-
| {{para|rtl}} || <kbd>yes</kbd> indicates that the writing system used for the content in {{para|text}} is right-to-left; accepted values are: <kbd>no</kbd> (default), <kbd>yes</kbd> || {{para|script}} ||
|-
| {{para|italic}} || {{crossref|see table "Langx {{pipe}}italic{{=}} parameter operation"}}; accepted values are: <kbd>yes</kbd>, <kbd>no</kbd>, <kbd>unset</kbd>, <kbd>invert</kbd>, <kbd>default</kbd> || – || {{para|italics}}, {{para|i}}
|-
| {{para|size}} || Specifies font size of the content in {{para|text}}; use a value suitable for use with the CSS <code>font-size</code> property; this should almost always be a relative value supplied in <kbd>{{mxt|%}}</kbd> or <kbd>{{mxt|em}}</kbd> units, not a fixed <kbd>{{!mxt|px}}</kbd> value. || – ||
|-
| {{para|engvar}} || Selects English variant spelling of 'romanised' or 'romanized' (default) according to the country specified; accepted values are: <kbd>au</kbd> (Australia), <kbd>ca</kbd> (Canada), <kbd>gb</kbd> (Great Britain), <kbd>ie</kbd> (Ireland), <kbd>in</kbd> (India), <kbd>nz</kbd> (New Zealand), <kbd>us</kbd> (United States), <kbd>za</kbd> (South Africa) || – ||
|-
| {{para|cat}} || Inhibits automatic categorization; mirror version of {{para|nocat}}; accepted values are: <kbd>no</kbd>, <kbd>n</kbd>, <kbd>false</kbd>, <kbd>f</kbd>, <kbd>off</kbd>, <kbd>0</kbd> || – ||
|-
| {{para|nocat}} || Inhibits automatic categorization; mirror version of {{para|cat}}; accepted values are: <kbd>yes</kbd>, <kbd>y</kbd>, <kbd>true</kbd>, <kbd>t</kbd>, <kbd>on</kbd>, <kbd>1</kbd> || – ||
|-
|}

{| class="wikitable"
|+ Langx {{pipe}}italic= parameter operation
|-
! {{pipe}}italic= value !! Description !! Example code !! Result !! HTML markup
|-
| rowspan="4" | {{Plainlist|
* parameter not present;
* parameter present, not set;
* invalid value
}}
| rowspan="7" | {{Plainlist|
* module applies style from:
* &nbsp;&nbsp;template setting, or
* &nbsp;&nbsp;{{pval|-latn}} script subtag;
* else inherits from external markup;
* invalid values treated as default
}}
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра}}</syntaxhighlight>
| {{langx|ru|тундра}}
| {{code|lang=html|{{Langx|ru|тундра}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|tûndra}}</syntaxhighlight>
| {{Langx|ru|tûndra}}
| {{code|lang=html|{{Langx|ru|tûndra}}}}<br />Incorrect markup; this requires script subtag {{pval|-latn}}.
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|fr|toundra}}</syntaxhighlight>
| {{Langx|fr|toundra}}
| {{code|lang=html|{{Langx|fr|toundra}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra}}
| {{code|lang=html|{{Langx|ru-latn|tûndra}}}}
|-
| rowspan="3" | <kbd>default</kbd>
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра|italic=default}}</syntaxhighlight>
| {{Langx|ru|тундра|italic=default}}
| {{code|lang=html|{{Langx|ru|тундра|italic=default}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|fr|toundra|italic=default}}</syntaxhighlight>
| {{Langx|fr|toundra|italic=default}}
| {{code|lang=html|{{Langx|fr|toundra|italic=default}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra|italic=default}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra|italic=default}}
| {{code|lang=html|{{Langx|ru-latn|tûndra|italic=default}}}}
|-
| rowspan="4" | <kbd>no</kbd>
| rowspan="4" | {{Plainlist|
* module applies upright style;
* overrides {{pval|-latn}} script subtag;
* overrides external markup
}}
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра|italic=no}}</syntaxhighlight>
| {{Langx|ru|тундра|italic=no}}
| {{code|lang=html|{{Langx|ru|тундра|italic=no}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|fr|toundra|italic=no}}</syntaxhighlight>
| {{Langx|fr|toundra|italic=no}}
| {{code|lang=html|{{Langx|fr|toundra|italic=no}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra|italic=no}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra|italic=no}}
| {{code|lang=html|{{Langx|ru-latn|tûndra|italic=no}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">''{{Langx|ru-latn|tûndra|italic=no}}''</syntaxhighlight>
| ''{{Langx|ru-latn|tûndra|italic=no}}''
| {{code|lang=html|''{{Langx|ru-latn|tûndra|italic=no}}''}}
|-
| rowspan="2" | <kbd>yes</kbd>
| rowspan="2" | {{Plainlist|
* module applies italic style;
* ignores {{pval|-latn}} script subtag
}}
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра|italic=yes}}</syntaxhighlight>
| {{Langx|ru|тундра|italic=yes}}
| {{code|lang=html|{{Langx|ru|тундра|italic=yes}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra|italic=yes}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra|italic=yes}}
| {{code|lang=html|{{Langx|ru-latn|tûndra|italic=yes}}}}
|-
| rowspan="4" | <kbd>unset</kbd>
| rowspan="4" | {{Plainlist|
* module applies no style;
* inherits style from external markup;
* overrides {{pval|-latn}} script subtag
}}
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра|italic=unset}}</syntaxhighlight>
| {{Langx|ru|тундра|italic=unset}}
| {{code|lang=html|{{Langx|ru|тундра|italic=unset}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">''{{Langx|ru|тундра|italic=unset}}''</syntaxhighlight>
| ''{{Langx|ru|тундра|italic=unset}}''
| {{code|lang=html|''{{Langx|ru|тундра|italic=unset}}''}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra|italic=unset}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra|italic=unset}}
| {{code|lang=html|{{Langx|ru-latn|tûndra|italic=unset}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">''{{Langx|ru-latn|tûndra|italic=unset}}''</syntaxhighlight>
| ''{{Langx|ru-latn|tûndra|italic=unset}}''
| {{code|lang=html|''{{Langx|ru-latn|tûndra|italic=unset}}''}}
|-
| rowspan="4" | <kbd>invert</kbd>
| rowspan="4" | {{Plainlist|
* module applies no style;
* inverts style in internal markup;{{efn|name=invertunset}}
* disables auto-italics
* overrides {{pval|-latn}} script subtag
}}
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|тундра|italic=invert}}</syntaxhighlight>
| {{Langx|ru|тундра|italic=invert}}
| {{code|lang=html|{{Langx|ru|тундра|italic=invert}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru|''тундра''|italic=invert}}</syntaxhighlight>
| {{Langx|ru|''тундра''|italic=invert}}
| {{code|lang=html|{{Langx|ru|''тундра''|italic=invert}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|tûndra|italic=invert}}</syntaxhighlight>
| {{Langx|ru-latn|tûndra|italic=invert}}
| {{code|lang=html|{{Langx|ru-latn|tûndra|italic=invert}}}}
|-
| <syntaxhighlight lang="wikitext" inline="1">{{Langx|ru-latn|''tûndra''|italic=invert}}</syntaxhighlight>
| {{Langx|ru-latn|''tûndra''|italic=invert}}
| {{code|lang=html|{{Langx|ru-latn|''tûndra''|italic=invert}}}}
|-
|}

===Notes===
{{Notelist|refs=
{{efn|name=invertunset|compare {{para|italic|invert}} to {{para|italic|unset}}:
:<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}</syntaxhighlight>
::{{Langx|de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}
:<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|''... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.''|italic=unset}}</syntaxhighlight>
::{{Langx|de|''... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.''|italic=unset}}}}
}}

=== TemplateData ===
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"label": "Language tag",
			"description": "A valid IETF language tag identifying the language of the non-English text.",
			"type": "string",
			"required": true
		},
		"2": {
			"label": "Text",
			"description": "The non-English text to display.",
			"type": "string",
			"required": true
		},
		"links": {
			"label": "Display link",
			"description": "Set to 'no' to disable the link to the article's language.",
			"type": "boolean",
			"aliases": [
				"link"
			]
		},
		"4": {
			"label": "Literal translation",
			"description": "The literal translation of the foreign text.",
			"type": "string",
			"aliases": [
				"lit",
				"translation"
			]
		},
		"3": {
			"label": "Transliteration",
			"description": "The transliteration of the foreign text, for languages that do not use the Latin alphabet. This field is ignored for languages that do use the Latin alphabet.",
			"type": "string",
			"aliases": [
				"translit"
			]
		},
		"label": {
			"label": "Language label",
			"description": "If 'none', suppresses language link and label. Other options may be available depending on the language.",
			"example": "none",
			"type": "line"
		},
		"rtl": {
			"label": "Right-to-left",
			"description": "Toggle right-to-left view for the foreign text.",
			"type": "boolean",
			"example": "yes",
			"default": "no"
		},
		"italic": {
			"label": "Italicize",
			"description": "Toggle italicization for the foreign text.",
			"type": "boolean",
			"default": "yes",
			"example": "no",
			"aliases": [
				"italics",
				"i"
			]
		},
		"size": {
			"label": "Font-size",
			"description": "Sets font-size for the foreign text.",
			"example": "120%, 1.2em"
		}
	},
	"description": "Indicates to readers the original form of a term or phrase in a foreign language.",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"links",
		"label",
		"rtl",
		"italic",
		"size"
	]
}
</templatedata>

== Examples ==
The following examples show translations from German.

'''Edit'''
* Weimar is located in the federal state of Thuringia (<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|Thüringen}}</syntaxhighlight>).
* The ''Seafarers of Catan'' (<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|Die Seefahrer von Catan}}</syntaxhighlight>) is an expansion of the board game ''[[The Settlers of Catan]]''.
* Albert the Bear (<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|Albrecht der Bär|links=no}}</syntaxhighlight>)
*''All Quiet on the Western Front'' (<syntaxhighlight lang="wikitext" inline="1">{{Langx|de|Im Westen nichts Neues|lit=In the West Nothing New}}</syntaxhighlight>) is a novel by [[Erich Maria Remarque]].

'''Resulting text'''
* Weimar is located in the federal state of Thuringia ({{Langx|de|Thüringen}}).
* The ''Seafarers of Catan'' ({{Langx|de|Die Seefahrer von Catan}}) is an expansion of the board game ''[[The Settlers of Catan]]''.
* Albert the Bear ({{Langx|de|Albrecht der Bär|links=no}})
* ''All Quiet on the Western Front'' ({{Langx|de|Im Westen nichts Neues|lit=In the West Nothing New}}) is a novel by [[Erich Maria Remarque]].

== 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}}
TODO: (2024-09-22) rename these categories

== See also ==
{{#invoke:Lang/documentor tool|see_also|{{{see-also|}}}}}
* {{tl|crh}} – Supports Latin, Cyrillic, and Arabic Crimean Tatar text
* {{Tl|Lang}}
* {{Tl|Language with name/for}}
* [[List of ISO 639 language codes]] (language codes)
* {{tl|IPA}}

<includeonly>{{Sandbox other||
[[Category:Wikipedia multilingual support templates]]
[[Category:Templates that add a tracking category]]
[[Category:Language tag handling templates]]
}}</includeonly>