Module:ISO 3166/doc: Difference between revisions

Content deleted Content added

Inline

Revision as of 20:21, 13 September 2018

This Lua module is used on 1,090,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 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

Subpages

@@ Line 42: / Line 42: @@
 ==See also==
 *[[Wikipedia:Templates for discussion/Log/2015 November 12#Template:ISO 3166 name DE-HB]] &ndash; discussion of replacement of [[Template:ISO 3166 conversion template doc|template-based system]] with Lua
+*[[Wikipedia:Templates_for_discussion/Log/2018_September_10#Template:ISO_3166_code-3_AD]] &ndash; discussion of full removal of [[Template:ISO 3166 conversion template doc|template-based system]]
-*{{tl|ISO 3166 name}} (now uses this module) and {{tl|ISO 3166 code}} (still uses template system; [[Template:ISO 3166 code/sandbox|sandbox]] exists)
+*{{tl|ISO 3166 name}} &ndash; (ISO name)
-*[[Module:ISO 3166/data|/data]] and [[:Category:ISO 3166 data templates]] &ndash; the data subpages used by this module
+*{{tl|Country name}} &ndash; (Standard name)
+*{{tl|ISO 3166 code}} &ndash; (Code)
+*{{tl|ISO 3166 code-3}} &ndash; (3 letter code)
+*{{tl|ISO 3166 numeric}} &ndash; (numeric code)
+*[[Module:ISO 3166/data|/data]] &ndash; the data subpages used by this module
 ==Subpages==