Toggle menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

This template is used inside other templates. 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.

Usage

  1. Articles specify the English variety parameter for relevant templates like {{example|engvar=en-US}}. They do not use {{engvar}}.
  2. Templates use {{engvar}}. 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 {{Use British English}} or {{Use American English}} being present on the page if no engvar is specified.

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

Example

Consider an example template, a fictive {{infobox personal likes}}. The demo is encoded in {{Engvar/doc/infobox demo}}.

Template code

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

Three articles

Template:Demo

Template:Demo

Template:Demo

A live example

Currently, {{infobox element}} has five {{engvar}} words. Phosphorus shows |engvar=en-UK despite the |engvar=en-US default.

Parameter list

Template

[[:Template:((]]engvar
<strong class="error"><span class="scribunto-error" id="mw-scribunto-error-ea9089f8">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.

English variety ISO-code
American English en-US
Australian English en-AU
British English en-GB
Canadian English en-CA
Hiberno-English (Irish-English) en-EI
Hong Kong English en-HK
Indian English en-IN
Jamaican English en-JM
Malawian English en-MW
New Zealand English en-NZ
Nigerian English en-NG
Pakistani English en-PK
Philippine English en-PH
Scottish English en-SCO
Singapore English en-SG
South African English en-ZA
Trinidadian English en-TT
British English Oxford spelling
British (Oxford) English
Oxford English Dictionary (OED)
en-OED
IUPAC spelling en-IUPAC

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 {{example|engvar=South African English}} 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 Template:Magic word 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

Template:Template data header

No description.

Template parameters

ParameterDescriptionTypeStatus
Default spellingdefaultword

The default word, usually the word in the English variety most often used

Example
colour
Stringsuggested
Default English varietydefaultLang

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
Stringsuggested
English varietyengvar

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
Stringrequired
Suppress maintenance categoryengvarCat

no description

Suggested values
{{{engvarCat|yes}}} no
Default
yes
Stringsuggested
Fallbackfallback

Whether Commonwealth English languages should fallback to en-GB if not specified

Default
false unless engvar=auto
Booleanoptional
Maintenance category sort keyengvarCatSort

no description

Default
{{pagename}}
Stringoptional
American English spellingen-US

no description

Example
color
Stringoptional
Australian English spellingen-AU

no description

Stringoptional
British English spellingen-GB

no description

Stringoptional
Canadian English spellingen-CA

no description

Stringoptional
Hiberno-English (Irish-English) spellingen-EI

no description

Stringoptional
Hong Kong English spellingen-HK

no description

Stringoptional
Indian English spellingen-IN

no description

Stringoptional
Jamaican English spellingen-JM

no description

Stringoptional
Malawian English spellingen-MW

no description

Stringoptional
New Zealand English spellingen-NZ

no description

Stringoptional
Nigerian English spellingen-NG

no description

Stringoptional
Pakistani English spellingen-PK

no description

Stringoptional
Philippine English spellingen-PH

no description

Stringoptional
Scottish English spellingen-SCO

no description

Stringoptional
Singapore English spellingen-SG

no description

Stringoptional
South African English spellingen-ZA

no description

Stringoptional
Trinidadian English spellingen-TT

no description

Stringoptional
British (Oxford) English spellingen-OED

no description

Stringoptional
IUPAC spellingen-IUPAC

no description

Stringoptional

See also