Template:Engvar/doc

This template is used inside other templates. <section begin="ledeMinusLeadSentence" />It allows templates to show national varieties of English, when |engvar= is passed by each article.

For example, one template can display "football" for |engvar=en-UK articles, and "soccer" for |engvar=en-US articles.<section end="ledeMinusLeadSentence" />

Usage

1. Articles specify the English variety parameter for relevant templates like Template:Tlc. They do not use Template:Tlc.
2. Templates use Template:Tlc. It should not forget to pass-through |engvar={{{engvar|}}}

...
| label3 = {{engvar |defaultWord=Colour |defaultLang=en-UK |en-US=Color |engvar={{{engvar|auto}}} }}
|  data3 = {{{color|}}}
| label4 = {{engvar |defaultWord=Football |defaultLang=en-UK |en-US=Soccer |engvar={{{engvar|auto}}} }} team
|  data4 = {{{team|}}}
...

The |defaultWord= be shown by default. But if an article asks for an English variety that has a corresponding parameter specified in the template, the value will be shown.

In the example, the template specified a British English word as default whenever no |engvar= is specified by the article. The word can be changed in an American English article by that article specifying |engvar=en-US. The fallback 'auto' value means it will try to determine the language based on templates like Template:Tl or Template:Tl being present on the page if no engvar is specified.

Note: Template:Tlc is unrelated to parameter names like |color= vs. |colour=. See programming option |data3={{{color|{{{colour|}}} }}}

Example

Consider an example template, a fictive Template:Tlf. The demo is encoded in {{Engvar/doc/infobox demo}}.

Template code

<strong class="error"><span class="scribunto-error mw-scribunto-error-aae1097f">Script error: No such module &quot;DecodeEncode&quot;.</span></strong>

Three articles

Personal likes

Demo: using WP:Engvar in templates
Home country	Wales
things
	Blue
team	FC Kuusysi
In this demo 'article', the template parameter is set: |engvar=(unspecified)

{{Engvar/doc/infobox demo
| home country = Wales
| color = Blue
| team  = [[FC Kuusysi]]
<!-- |engvar= not set; expect defaults -->
}}

Personal likes

Demo: using WP:Engvar in templates
Home country	Alaska
Favorite things
Color	Blue
Soccer team	FC Kuusysi
In this demo 'article', the template parameter is set: |engvar=en-US

{{Engvar/doc/infobox demo
| home country = Alaska
| color = Blue
| team  = [[FC Kuusysi]]
| engvar= en-US
}}

Personal likes

Demo: using WP:Engvar in templates
Home country	Australia
Favourite things
Colour	Blue
Association Football team	FC Kuusysi
In this demo 'article', the template parameter is set: |engvar=Australian

{{Engvar/doc/infobox demo
| home country = Australia
| color = Blue
| team  = [[FC Kuusysi]]
| engvar= Australian
}}

A live example

Currently, Template:Tl has five Template:Tlf words. Phosphorus shows |engvar=en-UK despite the |engvar=en-US default.

Parameter list

Template

{{engvar
<strong class="error"><span class="scribunto-error mw-scribunto-error-aae1097f">Script error: No such module &quot;DecodeEncode&quot;.</span></strong>

Article

{{example
| engvar =
| engvarCat =
}}

List of English varieties

In the template, use the exact ISO-code as the parameter name like |en-GB=vapour. Write |en-US=soccer not |American English=soccer. Needed varieties have articles using the template and words differing from the default.

There is backwards compatibility for leeway in articles. |engvar=en-US, |engvar=United States, |engvar=US can all show the |en-US=football variety.

Maintenance category

Articles with an invalid |engvar= will be placed in the hidden maintenance category Category:Articles using an unknown Template:Engvar option. Articles listed may need editing.

An article's requested |engvar= may be unspecified in the template. For example, if an article uses Template:Tlc but the template has no |en-ZA=, then the template will return |defaultWord=default color name. The category will not be used.

When this categorization is not desired for a whole template, set |engvarCat=no in the template

Otherwise pass-through this setting from the article: |engvarCat={{{engvarCat|yes}}}. This allows the editor to switch categorization off per article.

Articles are sorted by |engvarCatSort= or {{pagename}} by default. Note that other templates will fill this category. Set this parameter like |engvarCatSort=Personal prefs in a template to group its listings under "P".

Template data

No description.

Template parameters

Parameter		Description	Type	Status
Default spelling	defaultword	The default word, usually the word in the English variety most often used Example colour	String	suggested
Default English variety	defaultLang	Adding this helps document your {{engvar}} setting Suggested values en-US en-AU en-GB en-CA en-EI en-HK en-IN en-JM en-MW en-NZ en-NG en-PK en-PH en-SCO en-SG en-ZA en-TT en-OED en-IUPAC Example en-US	String	suggested
English variety	engvar	English variety to use. Set to 'auto' to try to detect variety based on templates such as {{Use British English}} or {{EngvarB}} being present on the page. Suggested values {{{engvar|auto}}} {{{engvar|}}} auto	String	required
Suppress maintenance category	engvarCat	no description Suggested values {{{engvarCat|yes}}} no Default yes	String	suggested
Fallback	fallback	Whether Commonwealth English languages should fallback to en-GB if not specified Default false unless engvar=auto	Boolean	optional
Maintenance category sort key	engvarCatSort	no description Default {{pagename}}	String	optional
American English spelling	en-US	no description Example color	String	optional
Australian English spelling	en-AU	no description	String	optional
British English spelling	en-GB	no description	String	optional
Canadian English spelling	en-CA	no description	String	optional
Hiberno-English (Irish-English) spelling	en-EI	no description	String	optional
Hong Kong English spelling	en-HK	no description	String	optional
Indian English spelling	en-IN	no description	String	optional
Jamaican English spelling	en-JM	no description	String	optional
Malawian English spelling	en-MW	no description	String	optional
New Zealand English spelling	en-NZ	no description	String	optional
Nigerian English spelling	en-NG	no description	String	optional
Pakistani English spelling	en-PK	no description	String	optional
Philippine English spelling	en-PH	no description	String	optional
Scottish English spelling	en-SCO	no description	String	optional
Singapore English spelling	en-SG	no description	String	optional
South African English spelling	en-ZA	no description	String	optional
Trinidadian English spelling	en-TT	no description	String	optional
British (Oxford) English spelling	en-OED	no description	String	optional
IUPAC spelling	en-IUPAC	no description	String	optional

See also

• HELP:ENGVAR
• Category:Articles using an unknown Template:Engvar option
• ISO 3166-1 alpha-2 -- The 2-letter country code
• Template:Ml - debugging