This is a documentation subpage for Module:ISO 3166. It may contain usage information, categories and other content that is not part of the original module page. |
This Lua module is used on 1,080,000+ pages, or roughly 2% 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.
Examples
editCountries (ISO 3166-1)
editAll 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.
Name
editTo 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
ISO Name
editTo 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
Alpha-2
editTo 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
Alpha-3
editTo 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
Numeric
editTo 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
Subdivisions (ISO 3166-2)
editInputs 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.
Code (alpha-2)
editTo 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
Name
editTo 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
Tracking categories
editSee also
edit- 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
Subpages
edit- ISO 3166/data
- ISO 3166/data/AD
- ISO 3166/data/AE
- ISO 3166/data/AF
- ISO 3166/data/AG
- ISO 3166/data/AI
- ISO 3166/data/AL
- ISO 3166/data/AM
- ISO 3166/data/AO
- ISO 3166/data/AQ
- ISO 3166/data/AR
- ISO 3166/data/AS
- ISO 3166/data/AT
- ISO 3166/data/AU
- ISO 3166/data/AW
- ISO 3166/data/AX
- ISO 3166/data/AZ
- ISO 3166/data/BA
- ISO 3166/data/BB
- ISO 3166/data/BD
- ISO 3166/data/BE
- ISO 3166/data/BF
- ISO 3166/data/BG
- ISO 3166/data/BH
- ISO 3166/data/BI
- ISO 3166/data/BJ
- ISO 3166/data/BL
- ISO 3166/data/BM
- ISO 3166/data/BN
- ISO 3166/data/BO
- ISO 3166/data/BQ
- ISO 3166/data/BR
- ISO 3166/data/BS
- ISO 3166/data/BT
- ISO 3166/data/BV
- ISO 3166/data/BW
- ISO 3166/data/BY
- ISO 3166/data/BZ
- ISO 3166/data/CA
- ISO 3166/data/CA/sandbox
- ISO 3166/data/CC
- ISO 3166/data/CD
- ISO 3166/data/CF
- ISO 3166/data/CG
- ISO 3166/data/CH
- ISO 3166/data/CI
- ISO 3166/data/CK
- ISO 3166/data/CL
- ISO 3166/data/CM
- ISO 3166/data/CN
- ISO 3166/data/CO
- ISO 3166/data/CR
- ISO 3166/data/CU
- ISO 3166/data/CV
- ISO 3166/data/CW
- ISO 3166/data/CX
- ISO 3166/data/CY
- ISO 3166/data/CZ
- ISO 3166/data/DE
- ISO 3166/data/DJ
- ISO 3166/data/DK
- ISO 3166/data/DM
- ISO 3166/data/DO
- ISO 3166/data/DZ
- ISO 3166/data/EC
- ISO 3166/data/EE
- ISO 3166/data/EG
- ISO 3166/data/EH
- ISO 3166/data/ER
- ISO 3166/data/ES
- ISO 3166/data/ET
- ISO 3166/data/FI
- ISO 3166/data/FJ
- ISO 3166/data/FK
- ISO 3166/data/FM
- ISO 3166/data/FO
- ISO 3166/data/FR
- ISO 3166/data/GA
- ISO 3166/data/GB
- ISO 3166/data/GB/sandbox
- ISO 3166/data/GD
- ISO 3166/data/GE
- ISO 3166/data/GF
- ISO 3166/data/GG
- ISO 3166/data/GH
- ISO 3166/data/GI
- ISO 3166/data/GL
- ISO 3166/data/GM
- ISO 3166/data/GN
- ISO 3166/data/GN/sandbox
- ISO 3166/data/GP
- ISO 3166/data/GQ
- ISO 3166/data/GR
- ISO 3166/data/GS
- ISO 3166/data/GT
- ISO 3166/data/GU
- ISO 3166/data/GW
- ISO 3166/data/GY
- ISO 3166/data/HK
- ISO 3166/data/HM
- ISO 3166/data/HN
- ISO 3166/data/HR
- ISO 3166/data/HT
- ISO 3166/data/HU
- ISO 3166/data/ID
- ISO 3166/data/IE
- ISO 3166/data/IL
- ISO 3166/data/IM
- ISO 3166/data/IN
- ISO 3166/data/IO
- ISO 3166/data/IQ
- ISO 3166/data/IR
- ISO 3166/data/IS
- ISO 3166/data/IT
- ISO 3166/data/JE
- ISO 3166/data/JM
- ISO 3166/data/JO
- ISO 3166/data/JP
- ISO 3166/data/KE
- ISO 3166/data/KG
- ISO 3166/data/KH
- ISO 3166/data/KI
- ISO 3166/data/KM
- ISO 3166/data/KN
- ISO 3166/data/KP
- ISO 3166/data/KR
- ISO 3166/data/KW
- ISO 3166/data/KY
- ISO 3166/data/KZ
- ISO 3166/data/LA
- ISO 3166/data/LB
- ISO 3166/data/LC
- ISO 3166/data/LI
- ISO 3166/data/LK
- ISO 3166/data/LR
- ISO 3166/data/LS
- ISO 3166/data/LT
- ISO 3166/data/LU
- ISO 3166/data/LV
- ISO 3166/data/LY
- ISO 3166/data/MA
- ISO 3166/data/MC
- ISO 3166/data/MD
- ISO 3166/data/ME
- ISO 3166/data/MF
- ISO 3166/data/MG
- ISO 3166/data/MH
- ISO 3166/data/MK
- ISO 3166/data/ML
- ISO 3166/data/MM
- ISO 3166/data/MN
- ISO 3166/data/MO
- ISO 3166/data/MP
- ISO 3166/data/MQ
- ISO 3166/data/MR
- ISO 3166/data/MS
- ISO 3166/data/MT
- ISO 3166/data/MU
- ISO 3166/data/MV
- ISO 3166/data/MW
- ISO 3166/data/MX
- ISO 3166/data/MY
- ISO 3166/data/MZ
- ISO 3166/data/NA
- ISO 3166/data/NC
- ISO 3166/data/NE
- ISO 3166/data/NF
- ISO 3166/data/NG
- ISO 3166/data/NI
- ISO 3166/data/NL
- ISO 3166/data/NO
- ISO 3166/data/NP
- ISO 3166/data/NR
- ISO 3166/data/NU
- ISO 3166/data/NZ