Module:Engvar/doc
It may contain usage information, categories and other content that is not part of the original module page.
This module allows an article to show a national variant of English (WP:ENGVAR) in templates, depending on individual article preference. Basically, the article page infobox can have |engvar=en-GB set to show en-GB spelling.
For example, a single template can show "football" text in en-UK articles, and "soccer" in en-US articles.
Usage
See {{Engvar }}.
{{#invoke:Engvar|variants
| defaultWord =
| engvar = {{{engvar|}}}<!-- Pass through article setting -->
| defaultLang =
| en-XX = <!-- Add country code for XX, and its word -->
| en-YY = <!-- Add more variants as might be needed -->
| engvarCat = {{{engvarCat|}}}
| engvarCatSort =
}}
|engvar=
This input (user input) is checked against a list of possible words ("en-US, American English, United States"). Internal identifier is the code like "en-US".
|engvarCatSort=
Sort text for maintenance category. Advise to set to project name like "rainbow" not "infobox rainbow" (all templates will fill this category!). Default is pagename.
- Maintenance category
Parameter list
In the
| defaultWord =
| defaultLang =
| engvar = {{{engvar|}}}<!-- Pass through the editor's choice -->
| en-XX = <!-- add country code for XX, and the nation language word -->
| en-YY = <!-- add more variants as might be needed -->
| engvarCat = {{{engvarCat|}}} <!-- yes/no; '=no' will suppress message category in article page) -->
In the parameter list, for the editor to see & use:
| 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.
See also
- HELP:ENGVAR
- Category:Articles using an unknown Template:Engvar option
- ISO 3166-1 alpha-2 -- The 2-letter country code
- {{#invoke:Engvar|explain|...}} - debugging