View source for Template:Lang-x/doc/parameters

==lang-xx==
<!-- {{#lst:Template:Lang-x/doc/parameters|lang_xx_parameters}} -->
<!--
<section begin=lang_xx_parameters />
{| class="wikitable"
|+ Lang-xx supported parameters
! Parameter !! Definition !! Yields to !! Alias
|-
|<code>text</code> || non-English text || – || <code><nowiki>{{{1}}}</nowiki></code>
|-
|<code>translit</code> || Latin script transliteration of the content in <code>text</code> || – || <code><nowiki>{{{2}}}</nowiki></code>
|-
|<code>translit-std</code> || standard used for the transliteration of the value of <code>translit</code>; accepted values are: <kbd>ISO</kbd>, <kbd>DIN</kbd>, <kbd>IAST</kbd>, <kbd>ALA</kbd>, <kbd>ALA-LC</kbd> || – ||
|-
|{{nowrap|<code>translit-script</code>}} || transliteration standard's script identifier || – ||
|-
|<code>translation</code> || literal English translation or gloss of the content in <code>text</code> || – || <code>lit</code>, <code><nowiki>{{{3}}}</nowiki></code>
|-
|<code>label</code> || 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) || – ||
|-
|<code>link</code> || <kbd>yes</kbd> (default) links language name and static text associated with <code>translit</code> and <code>translation</code>; accepted values are: <kbd>no</kbd>, <kbd>yes</kbd>; {{para|link|no}} does not unlink wikilinked labels set by {{para|label}} || – || <code>links</code>
|-
|<code>proto</code> || 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' || – || 
|-
|<code>code</code> || [[IETF language tag]] for the content in <code>text</code>; set by the template, overriding the template setting is discouraged || – ||
|-
|<code>script</code> || IETF language script subtag; sometimes set by the template when the language of the content in <code>text</code> 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 <code>italic</code>; overrides <code>rtl</code> || <code>italic</code> ||
|-
|<code>region</code> || IETF language region subtag || – ||
|-
|<code>variant</code> || IETF language variant subtag || – ||
|-
|<code>rtl</code> || <kbd>yes</kbd> indicates that the writing system used for the content in <code>text</code> is right-to-left; accepted values are: <kbd>no</kbd> (default), <kbd>yes</kbd> || <code>script</code> ||
|-
|<code>italic</code> || {{crossref|see table "lang-xx {{pipe}}italic{{=}} parameter operation"}}; accepted values are: <kbd>yes</kbd>, <kbd>no</kbd>, <kbd>unset</kbd>, <kbd>invert</kbd>, <kbd>default</kbd> || – || <code>italics</code>,<code>i</code>
|-
|<code>size</code> || specifies font size of the content in <code>text</code>; 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. || – ||
|-
|<code>engvar</code> || 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) || – ||
|-
|<code>cat</code> || inhibits automatic categorization; mirror version of <code>nocat</code>; accepted values are: <kbd>no</kbd>, <kbd>n</kbd>, <kbd>false</kbd>, <kbd>f</kbd>, <kbd>off</kbd>, <kbd>0</kbd> || – ||
|-
|<code>nocat</code> || inhibits automatic categorization; mirror version of <code>cat</code>; accepted values are: <kbd>yes</kbd>, <kbd>y</kbd>, <kbd>true</kbd>, <kbd>t</kbd>, <kbd>on</kbd>, <kbd>1</kbd> || – ||
|-
|}
{| class="wikitable"
|+ Lang-xx {{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;{{para|script|latn}};
*else inherits from external markup;
*invalid values treated as default}}
| <code><nowiki>{{lang-ru|тундра}}</nowiki></code> || {{lang-ru|тундра}} || {{code|{{lang-ru|тундра}}}}
|-
| <code>{{deprecated code|red=yes|<nowiki>{{lang-ru|tûndra}}</nowiki>}}</code> || {{lang-ru|tûndra}} || {{code|{{lang-ru|tûndra}}}}<br />Incorrect markup; this requires {{para|script|latn}}.
|-
| <code><nowiki>{{lang-fr|toundra}}</nowiki></code> || {{lang-fr|toundra}} || {{code|{{lang-fr|toundra}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra}}</nowiki></code> || {{lang-ru|script=latn|tûndra}} || {{code|{{lang-ru|script=latn|tûndra}}}}
|-
|rowspan="3"| <kbd>default</kbd> || <code><nowiki>{{lang-ru|тундра|italic=default}}</nowiki></code> || {{lang-ru|тундра|italic=default}} || {{code|{{lang-ru|тундра|italic=default}}}}
|-
| <code><nowiki>{{lang-fr|toundra|italic=default}}</nowiki></code> || {{lang-fr|toundra|italic=default}} || {{code|{{lang-fr|toundra|italic=default}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra|italic=default}}</nowiki></code> || {{lang-ru|script=latn|tûndra|italic=default}} || {{code|{{lang-ru|script=latn|tûndra|italic=default}}}}
|-
|rowspan="4"| <kbd>no</kbd> ||rowspan="4"| {{plainlist|
*module applies upright style;
*overrides {{para|script|latn}};
*overrides external markup}}
| <code><nowiki>{{lang-ru|тундра|italic=no}}</nowiki></code> || {{lang-ru|тундра|italic=no}} || {{code|{{lang-ru|тундра|italic=no}}}}
|-
| <code><nowiki>{{lang-fr|toundra|italic=no}}</nowiki></code> || {{lang-fr|toundra|italic=no}} || {{code|{{lang-fr|toundra|italic=no}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra|italic=no}}</nowiki></code> || {{lang-ru|script=latn|tûndra|italic=no}} || {{code|{{lang-ru|script=latn|tûndra|italic=no}}}}
|-
| <code><nowiki>''{{lang-ru|script=latn|tûndra|italic=no}}''</nowiki></code> || ''{{lang-ru|script=latn|tûndra|italic=no}}'' || {{code|''{{lang-ru|script=latn|tûndra|italic=no}}''}}
|-
|rowspan="2" | <kbd>yes</kbd> ||rowspan="2" | {{plainlist|
*module applies italic style;
*ignores {{para|script|latn}}}}
| <code>{{deprecated code|red=yes|<nowiki>{{lang-ru|тундра|italic=yes}}</nowiki>}}</code> || {{lang-ru|тундра|italic=yes}} || {{code|{{lang-ru|тундра|italic=yes}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra|italic=yes}}</nowiki></code> || {{lang-ru|script=latn|tûndra|italic=yes}} || {{code|{{lang-ru|script=latn|tûndra|italic=yes}}}}
|-
|rowspan="4"| <kbd>unset</kbd> ||rowspan="4"| {{plainlist|
*module applies no style;
*inherits style from external markup;
*overrides {{para|script|latn}}}}
| <code><nowiki>{{lang-ru|тундра|italic=unset}}</nowiki></code> || {{lang-ru|тундра|italic=unset}} || {{code|{{lang-ru|тундра|italic=unset}}}}
|-
| <code>{{deprecated code|red=yes|<nowiki>''{{lang-ru|тундра|italic=unset}}''</nowiki>}}</code> || ''{{lang-ru|тундра|italic=unset}}'' || {{code|''{{lang-ru|тундра|italic=unset}}''}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra|italic=unset}}</nowiki></code> || {{lang-ru|script=latn|tûndra|italic=unset}} || {{code|{{lang-ru|script=latn|tûndra|italic=unset}}}}
|-
| <code><nowiki>''{{lang-ru|script=latn|tûndra|italic=unset}}''</nowiki></code> || ''{{lang-ru|script=latn|tûndra|italic=unset}}'' || {{code|''{{lang-ru|script=latn|tûndra|italic=unset}}''}}
|-
|rowspan="4"| <kbd>invert</kbd> ||rowspan="4"| {{plainlist|
*module applies no style;
*inverts style in internal markup{{dagger}};
*disables auto-italics
*overrides script subtag <code>latn</code>;}}
| <code>{{deprecated code|red=yes|<nowiki>{{lang-ru|тундра|italic=invert}}</nowiki>}}</code> || {{lang-ru|тундра|italic=invert}} || {{code|{{lang-ru|тундра|italic=invert}}}}
|-
| <code><nowiki>{{lang-ru|''тундра''|italic=invert}}</nowiki></code> || {{lang-ru|''тундра''|italic=invert}} || {{code|{{lang-ru|''тундра''|italic=invert}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|tûndra|italic=invert}}</nowiki></code> || {{lang-ru|script=latn|tûndra|italic=invert}} || {{code|{{lang-ru|script=latn|tûndra|italic=invert}}}}
|-
| <code><nowiki>{{lang-ru|script=latn|''tûndra''|italic=invert}}</nowiki></code> || {{lang-ru|script=latn|''tûndra''|italic=invert}} || {{code|{{lang-ru|script=latn|''tûndra''|italic=invert}}}}
|-
|}
{{dagger}} compare {{para|italic|invert}} to {{para|italic|unset}}:
:<code><nowiki>{{Lang-de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}</nowiki></code>
::{{Lang-de|... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.|italic=invert}}
:<code><nowiki>{{Lang-de|''... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.''|italic=unset}}</nowiki></code>
::{{Lang-de|''... ein neues Opernprojekt in Angriff: ''Das Käthchen von Heilbronn'', nach Heinrich von Kleists gleichnamigem Drama.''|italic=unset}}
<section end=lang_xx_parameters />
-->