Bona motswedi wa Tempolete:ISO 3166 conversion template doc

<noinclude>
{{Documentation}}
</noinclude>{{Documentation|1=Template:ISO 3166 conversion template doc|content=
==Usage==

{{#switch:{{NAMESPACE}}|Template=
This template is part of a series that resolves the country and subdivision names to [[ISO 3166-1]] and [[ISO 3166-2]] codes, and vice versa.

In particular, {{Tlx|{{PAGENAME}}}} returns <includeonly>{{ {{PAGENAME}} }}</includeonly>.
|Category=This category contains part of the series of templates resolves the country and subdivision names to [[ISO 3166-1]] and [[ISO 3166-2]] codes, and vice versa.
|This {{lcfirst:{{NAMESPACE}}}} relates to a series of templates resolves the country and subdivision names to [[ISO 3166-1]] and [[ISO 3166-2]] codes, and vice versa.
}} 

{{#ifeq:{{Str len|{{{3|}}}}}|2|See also: [[ISO 3166-2:{{{3}}}]]}}

{{#if:{{{spec|}}}|
==Special case==
{{{spec|}}}
}}

==Sub-pages==
{{Special:Prefixindex/{{SUBJECTPAGENAME}}}}

==ISO 3166==
ISO 3166 defines names, two and three letter codes and code numbers for all countries and six character codes (the two letter country code followed by a dash and a two or three character subdivision code) for all top level subdivisions. 

==Using the family of templates==
We wish to convert between various identifiers that may loosely be defined as ''user input'' and ISO 3166 entities, there may be more than one way to do each conversion.  For our examples we use [[Pakistan]] as the country and [[Balochistan (Pakistan)]] as the subdivision.

The ISO-3166 identifiers for Pakistan are:
*Name: Pakistan
*Alpha-2 code:PK
*Alpha-3 code:PAK
*Numeric code:586

The ISO-3166 identifiers for Balochistan (Pakistan) is:
*Subdivision code:PK-BK

Now Pakistan also has a number of synonyms: for example [[Pakistán]]  and  [[پاکستان]]. 

Similarly Baluchistan is known, for example as [[Balochistan]] (on Wikipedia) and [[Bagh Sanjari]] .

; To get the '''Alpha-2''' code we can use {{Tlx|ISO 3166 code}} with any of the country identifiers ,or use the identifier as a part of the template name (faster).

* {{Tlx|ISO 3166 code|Pakistan}} {{ISO 3166 code|Pakistan}} 
* {{Tlx|ISO 3166 code|PK}} {{ISO 3166 code|PK}} 
* {{Tlx|ISO 3166 code|PAK}} {{ISO 3166 code|PAK}} 
* {{Tlx|ISO 3166 code|586}} {{ISO 3166 code|586}} 
* {{Tlx|ISO 3166 code|Pakistán}} {{ISO 3166 code|Pakistán}} 
* {{Tlx|ISO 3166 code|پاکستان}} {{ISO 3166 code|پاکستان}} 

* {{Tlx|ISO 3166 code Pakistan}} {{ISO 3166 code Pakistan}} 
* {{Tlx|ISO 3166 code PK}} {{ISO 3166 code PK}} 
* {{Tlx|ISO 3166 code PAK}} {{ISO 3166 code PAK}} 
* {{Tlx|ISO 3166 code 586}} {{ISO 3166 code 586}} 
* {{Tlx|ISO 3166 code Pakistán}} {{ISO 3166 code Pakistán}} 
* {{Tlx|ISO 3166 code پاکستان}} {{ISO 3166 code پاکستان}} 

; The '''alpha-3''' code is obtained similarly (but not currently using the template name method except for conversion from known good '''Alpha-2''').

* {{Tlx|ISO 3166 code-3|Pakistan}} {{ISO 3166 code-3|Pakistan}} 
* {{Tlx|ISO 3166 code-3|PK}} {{ISO 3166 code-3|PK}} 
* {{Tlx|ISO 3166 code-3|PAK}} {{ISO 3166 code-3|PAK}} 
* {{Tlx|ISO 3166 code-3|586}} {{ISO 3166 code-3|586}} 
* {{Tlx|ISO 3166 code-3|Pakistán}} {{ISO 3166 code-3|Pakistán}} 
* {{Tlx|ISO 3166 code-3|پاکستان}} {{ISO 3166 code-3|پاکستان}} 
* {{Tlx|ISO 3166 code-3 PK}} {{ISO 3166 code-3 PK}} 


; The '''numeric''' code is obtained similarly (but not currently using the template name method except for conversion from known good '''Alpha-2''').

* {{Tlx|ISO 3166 numeric|Pakistan}} {{ISO 3166 numeric|Pakistan}} 
* {{Tlx|ISO 3166 numeric|PK}} {{ISO 3166 numeric|PK}} 
* {{Tlx|ISO 3166 numeric|PAK}} {{ISO 3166 numeric|PAK}} 
* {{Tlx|ISO 3166 numeric|586}} {{ISO 3166 numeric|586}} 
* {{Tlx|ISO 3166 numeric|Pakistán}} {{ISO 3166 numeric|Pakistán}} 
* {{Tlx|ISO 3166 numeric|پاکستان}} {{ISO 3166 numeric|پاکستان}} 

* {{Tlx|ISO 3166 numeric PK}} {{ISO 3166 numeric PK}} 

;Finding the name is obtained similarly (but not currently using the template name method except for conversion from known good '''Alpha-2''').

* {{Tlx|ISO 3166 name|Pakistan}} {{ISO 3166 name|Pakistan}} 
* {{Tlx|ISO 3166 name|PK}} {{ISO 3166 name|PK}} 
* {{Tlx|ISO 3166 name|PAK}} {{ISO 3166 name|PAK}} 
* {{Tlx|ISO 3166 name|586}} {{ISO 3166 name|586}} 
* {{Tlx|ISO 3166 name|Pakistán}} {{ISO 3166 name|Pakistán}} 
* {{Tlx|ISO 3166 name|پاکستان}} {{ISO 3166 name|پاکستان}} 

* {{Tlx|ISO 3166 name PK}} {{ISO 3166 name PK}} 

;The subdivision code can be obtained in many ways

:Using a template name - this currently '''must''' use the canonical (usually ISO 3166) name for the country but can use implemented synonyms for the region.
* {{Tlx|ISO 3166 code Pakistan Baluchistan}} {{ISO 3166 code Pakistan Baluchistan}} 
* {{Tlx|ISO 3166 code Pakistan Balochistan}} {{ISO 3166 code Pakistan Balochistan}} 
* {{Tlx|ISO 3166 code Pakistan Bagh Sanjari}} {{ISO 3166 code Pakistan Bagh Sanjari}} 

:Using a template name and a parameter - can use implemented synonyms for the region and country - ISO 3166 entities are almost guaranteed to be implemented synonyms for countries.
* {{Tlx|ISO 3166 code Pakistan|Baluchistan}} {{ISO 3166 code Pakistan|Baluchistan}} 
* {{Tlx|ISO 3166 code Pakistan|Balochistan}} {{ISO 3166 code Pakistan|Balochistan}} 
* {{Tlx|ISO 3166 code Pakistan|Bagh Sanjari}} {{ISO 3166 code Pakistan|Bagh Sanjari}} 
* {{Tlx|ISO 3166 code Pakistán|Baluchistan}} {{ISO 3166 code Pakistán|Baluchistan}} 
* {{Tlx|ISO 3166 code Paquistán|Balochistan}} {{ISO 3166 code Paquistán|Balochistan}} 
* {{Tlx|ISO 3166 code PK|Baluchistan}} {{ISO 3166 code PK|Baluchistan}} 

:Using two parameters - can use implemented synonyms for the region and country - ISO 3166 entities are almost guaranteed to be implemented synonyms for countries.
* {{Tlx|ISO 3166 code|Pakistan|Baluchistan}} {{ISO 3166 code|Pakistan|Baluchistan}} 
* {{Tlx|ISO 3166 code|Pakistan|Balochistan}} {{ISO 3166 code|Pakistan|Balochistan}} 
* {{Tlx|ISO 3166 code|Pakistan|Bagh Sanjari}} {{ISO 3166 code|Pakistan|Bagh Sanjari}} 
* {{Tlx|ISO 3166 code|Pakistán|Baluchistan}} {{ISO 3166 code|Pakistán|Baluchistan}} 
* {{Tlx|ISO 3166 code|Paquistán|Balochistan}} {{ISO 3166 code|Paquistán|Balochistan}} 
* {{Tlx|ISO 3166 code|PK|Baluchistan}} {{ISO 3166 code|PK|Baluchistan}} 

;The subdivision name can be obtained similarly

* {{Tlx|ISO 3166 name PK-BA}} {{ISO 3166 name PK-BA}} 

:Using a template name and a parameter template name needs to be a valid alpha-2 currently. (not yet implemented)
* {{Tlx|ISO 3166 name PK|BA}} {{ISO 3166 name PK|BA}} 
* {{Tlx|ISO 3166 name PK|Balochistan}} {{ISO 3166 name PK|Balochistan}} 
* {{Tlx|ISO 3166 name PK|Bagh Sanjari}} {{ISO 3166 name PK|Bagh Sanjari}} 
* {{Tlx|ISO 3166 name PK|Baluchistan}} {{ISO 3166 name PK|Baluchistan}} 

:Using two parameters - can use implemented synonyms for the region and country - ISO 3166 entities are almost guaranteed to be implemented synonyms for countries.
* {{Tlx|ISO 3166 name|PK|Baluchistan}} {{ISO 3166 name|PK|Baluchistan}}
* {{Tlx|ISO 3166 name|Pakistan|Baluchistan}} {{ISO 3166 name|Pakistan|Baluchistan}}
* {{Tlx|ISO 3166 name|PK|Bagh Sanjari}} {{ISO 3166 name|PK|Bagh Sanjari}} 
* {{Tlx|ISO 3166 name|Pakistán|Baluchistan}} {{ISO 3166 name|Pakistán|Baluchistan}} 
* {{Tlx|ISO 3166 name|Paquistán|Balochistan}} {{ISO 3166 name|Paquistán|Balochistan}} 
* {{Tlx|ISO 3166 name|PK|Baluchistan}} {{ISO 3166 name|PK|Baluchistan}} 


==Cases where the non-ISO3166 name might be returned==
* Taiwan - ISO name is...
* Venezuela - ISO name is...
* Bolivia - ISO name is....
* ...

* Cases where the name is comma mangled - "Congo, The People's Democratic Republic of"
* Macedonia - ISO name is Macedonia, the former Yugoslav Republic of

==Enhancing the system==
# Adding country synonyms: these should redirect to the canonical template: the redirect should be categorised the same as the target, and sort-keyed as per the notes in the categories.
# Adding region synonyms: these can be a simple cut-and paste, but be sure to update any documentation variables.

}}

<includeonly>{{#ifeq:{{{4|}}}|name|{{#if:{{{2|}}}|[[Category:ISO 3166 name from code templates{{!}}{{{1}}} {{{2}}}]]|[[Category:ISO 3166 name from code country templates{{!}}{{{1|}}}]]}}|{{#if:{{{2|}}}|[[Category:ISO 3166 code from name templates{{!}}{{{1}}} {{{2}}}]]|[[Category:ISO 3166 code from name country templates{{!}}{{{1|}}}]]}}}}</includeonly>
<noinclude>
[[Category:Template documentation]]
</noinclude>