Module:ISO 3166/doc
This is the documentation page for Module:ISO 3166
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module returns a country's or subdivision's name from its ISO 3166 code (the name function), or vice versa (code).
Examples
Countries (ISO 3166-1)
All three types of ISO 3166-1 codes (alpha-2, alpha-3 and numeric) work as inputs to name, as well as to code (which can therefore also be used to convert between different code types). Use |codetype= to output alpha-3 or numeric codes in code instead of the default alpha-2 codes.
{{#invoke:ISO 3166|name|GB}}→ United Kingdom{{#invoke:ISO 3166|name|GBR}}→ United Kingdom{{#invoke:ISO 3166|name|826}}→ United Kingdom{{#invoke:ISO 3166|code|826}}→ GB{{#invoke:ISO 3166|code|United Kingdom}}→ GB{{#invoke:ISO 3166|code|UK}}→ GB{{#invoke:ISO 3166|code|United Kingdom|codetype=3}}→ GBR{{#invoke:ISO 3166|code|United Kingdom|codetype=alpha3}}→ GBR{{#invoke:ISO 3166|numeric|GB}}→ 826{{#invoke:ISO 3166|code|GB|codetype=numeric}}→ 826
Set |isoname= to return the country name as used in the ISO standard as opposed to the common name:
{{#invoke:ISO 3166|name|BO}}→ Bolivia{{#invoke:ISO 3166|name|BO|isoname=yes}}→ Bolivia, Plurinational State of{{#invoke:ISO 3166|name|GB}}→ United Kingdom{{#invoke:ISO 3166|name|GB|isoname=yes}}→ United Kingdom of Great Britain and Northern Ireland{{#invoke:ISO 3166|name|MO}}→ Macau{{#invoke:ISO 3166|name|MO|isoname=yes}}→ Macao
Subdivisions (ISO 3166-2)
Inputs to name must be valid ISO 3166-2 codes, i.e. the country's alpha-2 code for the first part, and up to three alphanumeric characters for the second part. They may be given normally (with a hyphen between the parts), or split between two unnamed parameters. For code, the first parameter is the country name (or any of its three codes, like above), and the second the subdivision name.
{{#invoke:ISO 3166|name|GB-ENG}}→ England{{#invoke:ISO 3166|name|GB|ENG}}→ England{{#invoke:ISO 3166|code|United Kingdom|England}}→ GB-ENG{{#invoke:ISO 3166|code|GBR|England}}→ GB-ENG{{#invoke:ISO 3166|code|GB|England}}→ GB-ENG
|isoname= works for subnational entities as well; keep in mind that ISO 3166-2 uses (transliterations of) local names that may differ from English ones. Set |lang= to a language code to switch between different languages for entities that have multiple ISO names. The default language for multilingual entities can be set on the country's data page.
{{#invoke:ISO 3166|name|BE|BRU}}→ Brussels{{#invoke:ISO 3166|name|BE|BRU|isoname=yes}}→ Bruxelles-Capitale, Région de{{#invoke:ISO 3166|name|BE|BRU|lang=fr}}→ Bruxelles-Capitale, Région de{{#invoke:ISO 3166|name|BE|BRU|lang=nl}}→ Brussels Hoofdstedelijk Gewest
See also
- Wikipedia:Templates for discussion/Log/2015 November 12#Template:ISO 3166 name DE-HB – discussion of replacement of template-based system with Lua
- Wikipedia:Templates_for_discussion/Log/2018_September_10#Template:ISO_3166_code-3_AD – discussion of full removal of template-based system
- {{ISO 3166 name}} – (ISO name)
- {{Country name}} – (Standard name)
- {{ISO 3166 code}} – (Code)
- {{ISO 3166 code-3}} – (3 letter code)
- {{ISO 3166 numeric}} – (numeric code)
- /data – the data subpages used by this module
Subpages