Template:Langx/doc

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

This template uses Lua:

Module:Lang (sandbox)

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 Wikipedia:Manual of Style/Text formatting § Foreign terms; italics for languages that use the Latin alphabet, normal for others.

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

The parameter |links=no prevents the language name from being linked.

The parameter |translit= allows for a romanization to be identified. This parameter is not supported by {{langx|<tag>|...}} templates for languages that are already written in Latin script.

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

Parameters

Langx supported parameters
Parameter	Definition	Yields to	Alias
`\|1=`	Language tag	–
`\|text=`	non-English text	–	`\|2=`
`\|translit=`	Latin script transliteration of the content in `\|text=`	–	`\|3=`
`\|translit-std=`	standard used for the transliteration of the value of `\|translit=`; accepted values are: `ISO`, `DIN`, `IAST`, `ALA`, `ALA-LC`	–
`\|translit-script=`	transliteration standard's script identifier	–
`\|translation=`	literal English translation or gloss of the content in `\|text=`	–	`\|lit=`, `\|4=`
`\|label=`	label to be used instead of template-provided language label; may be wikilinked; special keyword `none` causes the template to render without any labels (including transliteration and translation labels)	–
`\|link=`	`yes` (default) links language name and static text associated with `\|translit=` and `\|translation=`; accepted values are: `no`, `yes`; `\|link=no` does not unlink wikilinked labels set by `\|label=`	–	`\|links=`
`\|proto=`	accepted values are: `no` (default) or `yes` (default for private-use language tags with the `-x-proto` subtags); when `yes` (default or explicit), prefixes rendered text with an asterisk indicating 'unattested'	–
`\|code=`	IETF language tag for the content in `\|text=`; set by the template, overriding the template setting is discouraged	–
`\|script=`	IETF language script subtag; sometimes set by the template when the language of the content in `\|text=` uses more than one writing system; always four alpha characters; a value of `Latn` (not "Latin"!) forces italic rendering unless overridden by `\|italic=`; overrides `\|rtl=`	`\|italic=`
`\|region=`	IETF language region subtag	–
`\|variant=`	IETF language variant subtag	–
`\|rtl=`	`yes` indicates that the writing system used for the content in `\|text=` is right-to-left; accepted values are: `no` (default), `yes`	`\|script=`
`\|italic=`	see table "Langx \|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.	–
`\|engvar=`	selects English variant spelling of 'romanised' or 'romanized' (default) according to the country specified; accepted values are: `au` (Australia), `ca` (Canada), `gb` (Great Britain), `ie` (Ireland), `in` (India), `nz` (New Zealand), `us` (United States), `za` (South Africa)	–
`\|cat=`	inhibits automatic categorization; mirror version of `\|nocat=`; accepted values are: `no`, `n`, `false`, `f`, `off`, `0`	–
`\|nocat=`	inhibits automatic categorization; mirror version of `\|cat=`; accepted values are: `yes`, `y`, `true`, `t`, `on`, `1`	–

Langx |italic= parameter operation
\|italic= value	Description	Example code	Result	HTML markup
parameter not present; parameter present, not set; invalid value	module applies style from: template setting, or `\|script=latn`; else inherits from external markup; invalid values treated as default	`{{Langx\|ru\|тундра}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|ru\|tûndra}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru">tûndra</span>` Incorrect markup; this requires `\|script=latn`.
		`{{Langx\|fr\|toundra}}`	French: toundra	`[[French language\|French]]: <i lang="fr">toundra</i>`
		`{{Langx\|ru\|script=latn\|tûndra}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`default`		`{{Langx\|ru\|тундра\|italic=default}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|fr\|toundra\|italic=default}}`	French: toundra	`[[French language\|French]]: <i lang="fr">toundra</i>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=default}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`no`	module applies upright style; overrides `\|script=latn`; overrides external markup	`{{Langx\|ru\|тундра\|italic=no}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru" style="font-style: normal;">тундра</span>`
		`{{Langx\|fr\|toundra\|italic=no}}`	French: toundra	`[[French language\|French]]: <span lang="fr" style="font-style: normal;">toundra</span>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=no}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn" style="font-style: normal;">tûndra</span>`
		`''{{Langx\|ru\|script=latn\|tûndra\|italic=no}}''`	Russian: tûndra	`''[[Russian language\|Russian]]: <span lang="ru-Latn" style="font-style: normal;">tûndra</span>''`
`yes`	module applies italic style; ignores `\|script=latn`	`{{Langx\|ru\|тундра\|italic=yes}}`	Russian: тундра	`[[Russian language\|Russian]]: <i lang="ru">тундра</i>`
`yes`	module applies italic style; ignores `\|script=latn`	`{{Langx\|ru\|script=latn\|tûndra\|italic=yes}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`unset`	module applies no style; inherits style from external markup; overrides `\|script=latn`	`{{Langx\|ru\|тундра\|italic=unset}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`''{{Langx\|ru\|тундра\|italic=unset}}''`	Russian: тундра	`''[[Russian language\|Russian]]: <span lang="ru">тундра</span>''`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=unset}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>`
		`''{{Langx\|ru\|script=latn\|tûndra\|italic=unset}}''`	Russian: tûndra	`''[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>''`
`invert`	module applies no style; inverts style in internal markup^[a]; disables auto-italics overrides script subtag `latn`;	`{{Langx\|ru\|тундра\|italic=invert}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">''тундра''</span>`
		`{{Langx\|ru\|''тундра''\|italic=}invert}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=invert}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">''tûndra''</span>`
		`{{Langx\|ru\|script=latn\|''tûndra''\|italic=invert}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>`

Notes

^ compare |italic=invert to |italic=unset:
{{Langx|de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}
German: ... ein neues Opernprojekt in Angriff: Das Käthchen von Heilbronn, nach Heinrich von Kleists gleichnamigem Drama.

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Langx in articles based on its TemplateData.

TemplateData for Langx

Indicates to readers the original form of a term or phrase in a foreign language.

Template parameters
Parameter		Description	Type	Status
Language tag	`1`	A valid IETF language tag identifying the language of the non-English text.	String	required
Text	`2`	The non-English text to display.	String	required
Transliteration	`3` `translit`	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.	String	optional
Literal translation	`4` `lit` `translation`	The literal translation of the foreign text.	String	optional
Display link	`links` `link`	Set to 'no' to disable the link to the article's language.	Boolean	optional
Language label	`label`	If 'none', suppresses language link and label. Other options may be available depending on the language. Example none	Line	optional

Examples

The following examples show translations from German.

Edit

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.

Resulting text

Weimar is located in the federal state of Thuringia (German: Thüringen).
The Seafarers of Catan (German: Die Seefahrer von Catan) is an expansion of the board game The Settlers of Catan.
Albert the Bear (German: Albrecht der Bär)
All Quiet on the Western Front (German: Im Westen nichts Neues, lit. 'In the West Nothing New') is a novel by Erich Maria Remarque.

Tracking categories

TODO: (2024-09-22) rename these categories

Parameter	Definition	Yields to	Alias
`\|1=`	Language tag	–
`\|text=`	non-English text	–	`\|2=`
`\|translit=`	Latin script transliteration of the content in `\|text=`	–	`\|3=`
`\|translit-std=`	standard used for the transliteration of the value of `\|translit=`; accepted values are: `ISO`, `DIN`, `IAST`, `ALA`, `ALA-LC`	–
`\|translit-script=`	transliteration standard's script identifier	–
`\|translation=`	literal English translation or gloss of the content in `\|text=`	–	`\|lit=`, `\|4=`
`\|label=`	label to be used instead of template-provided language label; may be wikilinked; special keyword `none` causes the template to render without any labels (including transliteration and translation labels)	–
`\|link=`	`yes` (default) links language name and static text associated with `\|translit=` and `\|translation=`; accepted values are: `no`, `yes`; `\|link=no` does not unlink wikilinked labels set by `\|label=`	–	`\|links=`
`\|proto=`	accepted values are: `no` (default) or `yes` (default for private-use language tags with the `-x-proto` subtags); when `yes` (default or explicit), prefixes rendered text with an asterisk indicating 'unattested'	–
`\|code=`	IETF language tag for the content in `\|text=`; set by the template, overriding the template setting is discouraged	–
`\|script=`	IETF language script subtag; sometimes set by the template when the language of the content in `\|text=` uses more than one writing system; always four alpha characters; a value of `Latn` (not "Latin"!) forces italic rendering unless overridden by `\|italic=`; overrides `\|rtl=`	`\|italic=`
`\|region=`	IETF language region subtag	–
`\|variant=`	IETF language variant subtag	–
`\|rtl=`	`yes` indicates that the writing system used for the content in `\|text=` is right-to-left; accepted values are: `no` (default), `yes`	`\|script=`
`\|italic=`	see table "Langx \|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.	–
`\|engvar=`	selects English variant spelling of 'romanised' or 'romanized' (default) according to the country specified; accepted values are: `au` (Australia), `ca` (Canada), `gb` (Great Britain), `ie` (Ireland), `in` (India), `nz` (New Zealand), `us` (United States), `za` (South Africa)	–
`\|cat=`	inhibits automatic categorization; mirror version of `\|nocat=`; accepted values are: `no`, `n`, `false`, `f`, `off`, `0`	–
`\|nocat=`	inhibits automatic categorization; mirror version of `\|cat=`; accepted values are: `yes`, `y`, `true`, `t`, `on`, `1`	–

\|italic= value	Description	Example code	Result	HTML markup
parameter not present; parameter present, not set; invalid value	module applies style from: template setting, or `\|script=latn`; else inherits from external markup; invalid values treated as default	`{{Langx\|ru\|тундра}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|ru\|tûndra}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru">tûndra</span>` Incorrect markup; this requires `\|script=latn`.
		`{{Langx\|fr\|toundra}}`	French: toundra	`[[French language\|French]]: <i lang="fr">toundra</i>`
		`{{Langx\|ru\|script=latn\|tûndra}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`default`		`{{Langx\|ru\|тундра\|italic=default}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|fr\|toundra\|italic=default}}`	French: toundra	`[[French language\|French]]: <i lang="fr">toundra</i>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=default}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`no`	module applies upright style; overrides `\|script=latn`; overrides external markup	`{{Langx\|ru\|тундра\|italic=no}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru" style="font-style: normal;">тундра</span>`
		`{{Langx\|fr\|toundra\|italic=no}}`	French: toundra	`[[French language\|French]]: <span lang="fr" style="font-style: normal;">toundra</span>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=no}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn" style="font-style: normal;">tûndra</span>`
		`''{{Langx\|ru\|script=latn\|tûndra\|italic=no}}''`	Russian: tûndra	`''[[Russian language\|Russian]]: <span lang="ru-Latn" style="font-style: normal;">tûndra</span>''`
`yes`	module applies italic style; ignores `\|script=latn`	`{{Langx\|ru\|тундра\|italic=yes}}`	Russian: тундра	`[[Russian language\|Russian]]: <i lang="ru">тундра</i>`
`yes`	module applies italic style; ignores `\|script=latn`	`{{Langx\|ru\|script=latn\|tûndra\|italic=yes}}`	Russian: tûndra	`[[Russian language\|Russian]]: <i lang="ru-Latn">tûndra</i>`
`unset`	module applies no style; inherits style from external markup; overrides `\|script=latn`	`{{Langx\|ru\|тундра\|italic=unset}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`''{{Langx\|ru\|тундра\|italic=unset}}''`	Russian: тундра	`''[[Russian language\|Russian]]: <span lang="ru">тундра</span>''`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=unset}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>`
		`''{{Langx\|ru\|script=latn\|tûndra\|italic=unset}}''`	Russian: tûndra	`''[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>''`
`invert`	module applies no style; inverts style in internal markup^[a]; disables auto-italics overrides script subtag `latn`;	`{{Langx\|ru\|тундра\|italic=invert}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">''тундра''</span>`
		`{{Langx\|ru\|''тундра''\|italic=}invert}}`	Russian: тундра	`[[Russian language\|Russian]]: <span lang="ru">тундра</span>`
		`{{Langx\|ru\|script=latn\|tûndra\|italic=invert}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">''tûndra''</span>`
		`{{Langx\|ru\|script=latn\|''tûndra''\|italic=invert}}`	Russian: tûndra	`[[Russian language\|Russian]]: <span lang="ru-Latn">tûndra</span>`