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 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
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.
Name
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
ISO Name
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
Alpha-2
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
Alpha-3
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
Numeric
To get the numeric code use the code function with codetype = numeric or use the numeric function
{{#invoke:ISO 3166|numeric|GB}}→ Script error: The function "numeric" does not exist.{{#invoke:ISO 3166|code|GB|codetype=numeric}}→ 826
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.
Code (alpha-2)
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
Name
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}}→ Brussels{{#invoke:ISO 3166|name|BE|BRU|lang=fr}}→ Brussels{{#invoke:ISO 3166|name|BE|BRU|lang=nl}}→ Brussels
Tracking categories
- Category:Wikipedia page with obscure country (0)
- Category:Wikipedia page with obscure country or subdivision (0)
- Category:Wikipedia page with obscure subdivision (0)
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)
- Module:ISO 3166/data – the data subpages used by this module
Subpages
local p = {}
local data = mw.loadData("Module:ISO 3166/data/National")
local function cerror(eot,errortext,inputtext)
if eot=="empty" then
return ""
elseif eot=="input" then
return inputtext
else
return mw.html.create("span"):addClass("error"):wikitext(errortext)
end
end
local function strip(text)
text = string.upper(text) --Case insensitivity
text = string.gsub(text,"^THE ","") --Remove definite article
text = string.gsub(text,"[%s%-%,%.%(%)%/%\']","") --Remove spacing and punctuation
--text = string.gsub(text,"[\768-\879]","") --Unicode deaccenting doesn't work
return text
end
local function findname(code,cdata,qry)
local sqry = strip(qry)
if cdata["name"] and sqry==strip(cdata["name"])
or cdata["isoname"] and sqry==strip(cdata["isoname"])
or sqry==code or sqry==cdata["alpha3"] or sqry==cdata["numeric"]
then
return true
end
for _,tname in ipairs(cdata["altnames"] or {}) do
if sqry==strip(tname) then
return true
end
end
return false
end
function p.luaname(args)
local eot = args.error
if not args[1] then
return cerror(eot,"No parameter given",args[2] or "")
end
local code1 = string.upper(args[1] or "")
local code2 = string.upper(args[2] or "")
if string.find(code1,"%-") then
code1, code2 = string.match(code1,"^([^%-]*)%-(.*)$")
end
if --Check if valid code
--No non-alphanumeric characters allowed
string.find(code1..code2,"[^A-Z0-9]")
--3166-1 codes can be two or three letters or three digits;
--3166-2 codes must be two letters (first part) and 1-3 letters or digits (second part)
or not (string.find(code1,"^%u%u%u?$") or string.find(code1,"^%d%d%d$"))
or not string.find(code2,"^%w?%w?%w?$")
or not (string.find(code1,"^%u%u$") or code2=="")
then
if code2=="" then
return cerror(eot,"Invalid ISO 3166-1 code "..code1,code1)
else
return cerror(eot,"Invalid ISO 3166-2 code "..code1.."-"..code2,code1.."-"..code2)
end
end
if string.find(code1,"^%u%u$") then
if code2=="" then
--3166-1 alpha-2 code
if data[code1] then
return args.isoname and data[code1]["isoname"] or data[code1]["name"]
else
return cerror(eot,"Unknown ISO 3166-1 code "..code1,code1)
end
else
--3166-2 code
local sdata
if data[code1] then
sdata = mw.loadData("Module:ISO 3166/data/"..code1)
else
return cerror(eot,"Unknown ISO 3166-1 code "..code1,code1.."-"..code2)
end
if sdata[code2] then
return args.isoname and sdata[code2]["isoname"] or sdata[code2]["name"]
else
for _,_ in pairs(sdata) do
return cerror(eot,"Unknown ISO 3166-2 code "..code1.."-"..code2,code1.."-"..code2)
end
return cerror(eot,"No subdivision codes for "..data[code1]["name"],code1.."-"..code2)
end
end
else
--3166-1 alpha-3 or numeric code
local codetype = string.find(code1,"%d") and "numeric" or "alpha3"
for alpha2,cdata in pairs(data) do
if cdata[codetype]==code1 then
return args.isoname and cdata["isoname"] or cdata["name"]
end
end
return cerror(eot,"Unknown ISO 3166-1 code "..code1,code1)
end
end
function p.name(frame)
local args = require("Module:Arguments").getArgs(frame)
return p.luaname(args)
end
function p.luacode(args)
local eot = args.error
if not args[1] then
return cerror(eot,"No parameter given",args[2] or "")
end
if not args[2] then
--3166-1 code
for alpha2,cdata in pairs(data) do
if findname(alpha2,cdata,args[1]) then
if args["codetype"]=="numeric" or args["codetype"]=="alpha3" then
return cdata[args["codetype"]]
else
return alpha2
end
end
end
return cerror(eot,"Unknown country name "..args[1],args[1])
else
--3166-2 code
for alpha2,cdata in pairs(data) do
if findname(alpha2,cdata,args[1]) then
local sdata = mw.loadData("Module:ISO 3166/data/"..alpha2)
local empty = true
for scode,scdata in pairs(sdata) do
empty = false
if findname(scode,scdata,args[2]) then
return alpha2.."-"..scode
end
end
if empty then
return cerror(eot,"No subdivision codes for "..args[1],args[2])
else
return cerror(eot,"Unknown subdivision name "..args[2],args[2])
end
end
end
return cerror(eot,"Unknown country name "..args[1],args[2])
end
end
function p.code(frame)
local args = require("Module:Arguments").getArgs(frame)
return p.luacode(args)
end
function p.subpagetest(frame)
local code = frame.args[1]
local sdata
if not data[code] then
return "" --Unassigned or reserved 3166-1 code
else
local sname = "Module:ISO 3166/data/"..code
if not mw.title.new(sname).exists then
return "[[sname|-]]" --Data subpage doesn't exist
else
sdata = mw.loadData(sname)
end
end
for _,_ in pairs(sdata) do
return "n" --Non-empty 3166-2 entry
end
return "e" --Empty 3166-2 entry
end
return p