Module:ISO 3166/doc

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This Lua module is used on approximately 910,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module returns a country's or subdivision's code (alpha-2, alpha-3, numeric) or name (ISO, non-ISO) from ISO 3166 from a variety of inputs (alpha-2, alpha-3, numeric, name, ISO-name, alternative names). The module also removes junk from the input.

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.

To get the common name use the name function

• {{#invoke:ISO 3166|name|GB}} → United Kingdom
• {{#invoke:ISO 3166|name|GBR}} → United Kingdom
• {{#invoke:ISO 3166|name|826}} → United Kingdom

To get the ISO name use the name function with isoname = yes

• {{#invoke:ISO 3166|name|GB|isoname=yes}} → United Kingdom of Great Britain and Northern Ireland
• {{#invoke:ISO 3166|name|GBR|isoname=yes}} → United Kingdom of Great Britain and Northern Ireland
• {{#invoke:ISO 3166|name|826|isoname=yes}} → United Kingdom of Great Britain and Northern Ireland

To get the alpha 2 code use the code function

• {{#invoke:ISO 3166|code|826}} → GB
• {{#invoke:ISO 3166|code|United Kingdom}} → GB
• {{#invoke:ISO 3166|code|UK}} → GB

To get the alpha 3 code use the code function with codetype = 3

• {{#invoke:ISO 3166|code|United Kingdom|codetype=alpha3}} → GBR
• {{#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|UK|codetype=alpha3}} → GBR

To get the numeric code use the code function with codetype = numeric or use the numeric function

• {{#invoke:ISO 3166|numeric|GB}} → 826
• {{#invoke:ISO 3166|code|GB|codetype=numeric}} → 826

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.

To get the alpha-2 code of a subdivision use the code function with parameter 1 being the country and parameter 2 being the subdivision

• {{#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

To get the name of a subdivision use the name function with parameter 1 being the country and parameter 2 being the subdivsion or parameter 1 being the subdivsion code

• {{#invoke:ISO 3166|name|GB-ENG}} → England
• {{#invoke:ISO 3166|name|GB|ENG}} → England

|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

• Category:Wikipedia articles with obscure country (31)
• Category:Wikipedia articles with obscure country or subdivision (2)
• Category:Wikipedia articles with obscure subdivision (731)

• 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)
• Module:ISO 3166/data – the data subpages used by this module