Template:ISO 4217/code/doc

This is a documentation subpage for Template:ISO 4217/code.
It may contain usage information, categories and other content that is not part of the original template page.

Utilising the alpha3 ISO 4217 code. For example, the code number can be derived from the code. Based on the ISO 4217 Standfard definition (per {{ISO 4217/cite}}, as of October 2022^[update]).

There are 304 unique codes (ADP..ZWR). Codes are reused (as currency in history, in history with different end-date by country, in List Two funds, in entities) resulting in 452 currency definitions (data rows).

ISO 4217 code (P498)

General

|iso-code=

|format=

|is-obsolete=

Most parameters work by {{yesno}} principle: yes, 1, true, <anytext> and no, 0, false, <blank> are recognised as T/F.

|format=-options can be comma-separated list: |format=option-none, ISO4217-cat, mono, brackets, (as announced per template)

Base: iso-code

ISO 4217/code

{{ISO 4217/code}}

Returns valid ISO 4217 code or blank.

|iso-code=

Basic: |format=<blank> returns EITHER the code as exists OR <blank> (no tracking etc)

|format=option-none, ISO4217-cat

See § maintenance-category ISO4217

Other data (ref, comment) elsewhere. Data as of 17 October 2022^[update], per source {{ISO 4217/cite}}

iso-code error (maintenance category)

|format=ISO4217-cat will categorise articles with ISO-codes that do not exist in ISO. Sorted under C.

(When in Template space, a wikilink to the category will show: |iso-code=ZZZ → ISOcat-C*)

See § maintenance-category ISO4217

option-none (code='None')

|format=option-none will allow |iso-code=''None'', none, no (formatting is optional).

{{ISO 4217/code-none}} will return (show) |iso-code=''None'' (as formatted).

Internally, {{ISO 4217/code-none}} returns _NONE_ or <blank>.

When code "None" is not allowed |format=option-none, |iso-code=None input is considered unrecognised code (returns blank). Will be categorised from mainspace, sorted under N.

(In Template space: |iso-code=None → ISOcat-N*)

See § maintenance-category ISO4217

Examples

in	plain	is "None"?	`\|format=option-none` option-none=<absent>	`\|format=ISO4217-cat`	number	minor unit
`\|iso-code=USD`	USD		USD	USD	(840)	0.01
`\|iso-code=''None''`		_NONE_	None ISOcat-N*	None
`\|iso-code=ZZZ`				ISOcat-C*
`\|iso-code=<blank>`

Derived value templates

minor unit

"Minor unit" in ISO 4217: number of decimals for minor unit used in currency trade. For example, USD has Minor unit=2, i.e. 0.01 (dollarcent unit).

Occurring values are: <blank>, N.A., 0, 2, 3, 4. So, incidentally, 1 (for ¤ 0.1) is not present. Obsolete currency (historical, List Three): has no minor unit ("blank").

{{ISO 4217/code-minor-unit}}

In enwiki: "<blank>", "N.A.", "0" all return blank, because "¤ 1" is not a subunit of "¤ 1".

|iso-code=, |is-obsolete=, |format=blank/default (0.001-form), exponent (N.A., <blank>, 0, 2, 3, 4)
Examples: <blank> AFA: →; N.A. XPD: N.A. →; 0 KRW: →; 1 (not present); 2 RUB: 2 → 0.01; 3 OMR: 3 → 0.001; 4 CLF: 4 → 0.0001

Ambiguous code & minor units

10 codes are ambiguous: they appear both obsolete and active: |ANG|EUR|HRK|IDR|MWK|PEN|RON|SDG|SZL|TRY.

For example, PEN refers to an obsolete and an active currency. These have different exponents.; |is-obsolete=no/yes sets the right one. Default is: |is-obsolete=no (currency PEN is active}})
Example: PEN is ambiguous, required |is-obsolete= specifier.; USD is not ambiguous (active, |is-obsolete= is trivial); ESA is not ambiguous (historical, List Three; |is-obsolete= is trivial); Other not a code

PEN

|is-obsolete=1999 >< (obsolete)

|is-obsolete=no >0.01< (active)

|is-obsolete= >0.01< (active, default)

|<absent>= >0.01< (active, default)

USD >0.01<
PEN >0.01<
FOO ><
blank ><

is-obsolete=1999

USD >0.01<
PEN ><
FOO ><
blank ><

is-obsolete=no

USD >0.01<
PEN >0.01<
FOO ><
blank ><

is-obsolete=yes

USD >0.01<
PEN ><
FOO ><
blank ><

code-to-number

{{ISO 4217/code-to-number}} ({{../format}})

Code and number are 1:1 (code=number; number=code).
Three codes defined to have no number: XFO, XFU, XRE (all obsolete)
As of 17 October 2022^[update]: 304 existing unique alpha3-codes (over Lists One, Two and Three). Alphacode can have zero or one number (but not multiple). Numbers can repeat (eg ALL, ALK=008).

|format=<blank>, plain [=default]; brackets

Follows from code. Unknown code=blank. No tracking.

code-is-ambiguous

10 codes are ambiguous, they appear both obsolete and active: |ANG|EUR|HRK|IDR|MWK|PEN|RON|SDG|SZL|TRY.

For example, EUR is active in GERMANY, and obsolete in SERBIA AND MONTENEGRO per withdrawal-date=2006-10 (List Three). As of 17 October 2022.

When such code is used, disambiguation may be required (is-obsolete=yes/no), to specify which currency is intended. This is relevant with minor-unit, and manually setting (clarifying)is-obsolete. Used in {{Infobox currency}}.

|format=ISO4217-cat: The article using an ambiguous code, will be categorised, sort under A (for checking, not an error indication).

{{ISO 4217/code-is-ambiguous}}

|format=iso-code, ISO4217-cat |yes-text=anytext, <blank> (note: |yes-text=<blank> is counter-intuitive; useful for categorisation)

|yes-text=<blank> → no returntext (use for silent categorisation |ISOcat=yes)

Tracking: |ISOcat=yes: when ambiguous then → in Category:Pages using ISO 4217 currency to check (0) (catsort under A)

default USD → ><

PEN → >PEN<

|ISOcat=yes → >PEN<

|yes-text=_YES-is-ambig_ → >_YES-is-ambig_<

|yes-text=<blank> → >< So status=yes, but yes-returntext is suppressed

|yes-text=<blank>, |ISOcat=yes → >< So status=yes, but yes-returntext is suppressed

Extended content

USD → ><

FOO → ><

PEN → >PEN<

ISOcat=yes: USD → ><; FOO → ><; PEN → >PEN<

ISOcat=blank: USD → ><; FOO → ><; PEN → >PEN<

yes-text=_YES-is-ambig_: USD → ><; FOO → ><; PEN → >_YES-is-ambig_<

yes-text=<blank>: USD → ><; FOO → ><; PEN → >< So status=yes, but yes-returntext is suppressed; PEN → >< So status=yes, but yes-returntext is suppressed

code-to-withdrawal-date

{{ISO 4217/code-to-withdrawal-date}}
Note: |is-obsolete=yes/no required for ambivalent currencies: ANG, EUR, HRK, IDR, MWK, PEN, RON, SDG, SZL, TRY

These codes are both in list-1 and list-3 (active and obsolete). So one must specify wheteher active (no |is-obsolete=<blank>, no or obsolete |withdr-date=1999, yes No tracking. Multiple witdrawal-dats possible

Used in {{ISO 4217/code-minor-unit}}

Not in mainspace

As of 1 Nov 2022

code-is-obsolete

Template:ISO 4217/code-is-obsolete (backlinks edit) returns ISO withdrawal-date or blank.
Template:ISO 4217/code-is-obsolete/calc (backlinks edit) returns ISO withdrawal-date or blank.

|iso-code, is-obsolete=

The logic

|iso-code=, determines from ISO 4217. Thew code can be ambiguous.

|is-obsolete=: yes/no (T/F), blank='unknown'

{{yesno}} is applied: |is-obsolete=no, false=no (not obsolete, so active), |is-obsolete=<any text> is yes (obsolete)

Currency is obsolete?
		`\|is-obsolete=T/F/unk`
		T=obs₀₁	F=act₀₂	unk₀₃
code `\|iso-code= ABC/unk` →`T/F/ambig/unk`
	T=obs₁₀	OBS₁₁	N→ACT₁₂	OBS₁₃
	F=act₂₀	N→OBS₂₁	ACT₂₂	ACT₂₃
	ambig₃₀	OBS₃₁	ACT₃₂	ACT (default)₃₃
	unk₄₀	OBS₄₁	ACT₄₂	ACT (default)₄₃

N Contradicting situation: Obsolete vs. Active. By default |code-priority=no, so |is-obsolete=T/F decides.

Contradiction solving

Two situations imply a contradiction: the ISO-status contradicts the entered |is-obsolete= status. This may occur when an infobox covers more than one currency. The default handling is: |is-obsolete= takes precedence. By setting |code-priority=yes gives ISO code prority (result opposite). This does not resolve the contradiction.

Currency is obsolete?
`\|code-priority=no` (default)
		`\|is-obsolete=T/F/unk`
		T=obs₀₁	F=act₀₂
code `\|iso-code=...` →`T/F/...`
	T=obs₁₀	OBS₁₁	N→ACT₁₂
	F=act₂₀	N→OBS₂₁	ACT₂₂

`\|code-priority=yes`
	N→OBS₁₂
N→ACT₂₁

Returns: when Obsolete, a text; when Active, no text (blank). On can apply this as {{#if:{{code-is-obsolete|...}}|Obsolete|Active}}.

The returntext is:

When obsolete: 1. the |is-obsolete=anytext; 2. the |withdrawal-date=, 3. |obs-text=..., 4. "OBS"

When active: 1. |act-text=... 2. <blank>

Note that, by entering a blank |obs-text=, the returntext will be a blank (so, same as default actual returntext!)

|obs-text=, |act-text= overwrites.

In {{Infobox currency}}: For |obsolete=, |obsolete= of the infobox is used: |obsolete={{{obsolete|}}}

Examples

|iso-code=, |is-obsolete=

USD, active

USD ><

ATS, Austria shilling - withdrawn

ATS >2002-03<

PEN, PERU Nuevo Sol (ambivalent so wsdate needed)

PEN >< -- defaults to Active

FOO, not a code

FOO ><

"None", not a code

noNe ><

blank

><

code-entity-list

Template:ISO 4217/code-entity-list (backlinks edit) ( {{../demo}} · edit )
PEN [2]

L1 [1]: PERU

L2 [0]:

L3 [1]: PERU

OBS >ACT< ambival:>2015-12<

COU [2]

L1 [1]: COLOMBIA

L2 [1]: COLOMBIA

L3 [0]:

OBS >ACT<

EUR [36]

L1 [35]: EUROPEAN UNION, ÅLAND ISLANDS, ANDORRA, AUSTRIA, BELGIUM, CYPRUS, ESTONIA, FINLAND, FRANCE, FRENCH GUIANA, FRENCH SOUTHERN TERRITORIES (THE), GERMANY, GREECE, GUADELOUPE, HOLY SEE (THE), IRELAND, ITALY, LATVIA, LITHUANIA, LUXEMBOURG, MALTA, MARTINIQUE, MAYOTTE, MONACO, MONTENEGRO, NETHERLANDS (THE), PORTUGAL, RÉUNION, SAINT BARTHÉLEMY, SAINT MARTIN (FRENCH PART), SAINT PIERRE AND MIQUELON, SAN MARINO, SLOVAKIA, SLOVENIA, SPAIN

L2 [0]:

L3 [1]: SERBIA AND MONTENEGRO

OBS >ACT< ambival:>2006-10<

ATS [1]

L1 [0]:

L2 [0]:

L3 [1]: AUSTRIA

OBS >2002-03<

USD [19]

L1 [19]: UNITED STATES OF AMERICA (THE), AMERICAN SAMOA, BONAIRE, SINT EUSTATIUS AND SABA, BRITISH INDIAN OCEAN TERRITORY (THE), ECUADOR, EL SALVADOR, GUAM, HAITI, MARSHALL ISLANDS (THE), MICRONESIA (FEDERATED STATES OF), NORTHERN MARIANA ISLANDS (THE), PALAU, PANAMA, PUERTO RICO, TIMOR-LESTE, TURKS AND CAICOS ISLANDS (THE), UNITED STATES MINOR OUTLYING ISLANDS (THE), VIRGIN ISLANDS (BRITISH), VIRGIN ISLANDS (U.S.); L2 [0]:; L3 [0]:; OBS >ACT<
edge

ZZZ [0] Not an ISO 4217 code

OBS >ACT<

[0] Not an ISO 4217 code

OBS >ACT<

code-count

Template:ISO 4217/code-count (backlinks edit)

{{ISO 4217/code-count|iso-code=|list=}}

|list, iso-code=L1, ..., L123

Number of "XYZ" code repetition per list, and over all tyhree lsits. There are 304 unique codes, repetitions make 450 different lines (code, List, entity, end-date can be repeated).

Intended for checking and listformatting only (no new information).

See § code-entity-list for demo

code-to-qid

Template:ISO 4217/code-to-qid (backlinks edit)

{{ISO 4217/code-to-qid|iso-code=|format=}}

|format=plain, wl, wl-info, <blank>

ISO 4217 code (P498), ~265, As of 08:58, 13 November 2022 (UTC)

Maintenance-category (ISO 4217)

Cat:ISO 4217: →

{{ISO 4217/maintenance-category}}

Sets Category:Pages using ISO 4217 currency to check (0), used in various templates.

Distinguishes: mainspace (=categorise), template space (=colon-link :Category:Pages using ...), all other spaces (no effect).

{{ISO 4217/maintenance-category
|main-sort=
|template-sort=
}}

In template space: {{ISO 4217/maintenance-category}}

In the templates, activated by |ISO4217-cat= or by |format=.., ISO4217-cat, ..

Used by: {{ISO 4217/code}}, {{Infobox central bank}}, {{Infobox currency}} (projected as of October 2022)

Backoffice

The templates

Deployed in mainspace

{{/format}} · {{../testcases}}

{{ISO 4217/maintenance-category}} (Category:Pages using ISO 4217 currency to check (0))

Not yet used in / fit for mainspace

{{ISO 4217/code-to-withdrawal-date}}
{{ISO 4217/code-is-obsolete}}
{{ISO 4217/code-entity-list}}
{{ISO 4217/code-to-qid}} -- curation; dated (13 Nov 2022)

todo

IB does cat eponym eg in euro

v t e ISO 4217 templates
T:ISO 4217 * · T:IB Currency *
ISO 4217	{{ISO 4217}} (talk)
{{ISO 4217/cite}}	website: {{ISO 4217/cite/SIX Group}} L1 {{ISO 4217/cite/List One}} L2 {{ISO 4217/cite/List Two}} L3 {{ISO 4217/cite/List Three}} Amend {{ISO 4217/cite/Amendments}} Data Analysis
{{ISO 4217/code}}	{{/doc}} {{/testcases}} {{/demo}} {{/count}} {{/entity-list}} {{/code-none}} {{/is-ambiguous}} {{/minor}} {{/number}} {{/qid}} {{/maintenance-category}} Hist: {{/is-obsolete}} β {{/withdr-date}} β
{{Infobox currency}}	Infobox currency/sandbox (edit · t · history · diff · links · /test · Source · e · t · hist · links · /subpages · /doc · /doc edit) TPU
Other	{{Infobox cryptocurrency}} TPU {{Infobox central bank}} TPU wl: {{Iso4217}} fmt: {{BDT}} ISO 4217:CHE (R)
Wikidata	ISO 4217 (Q37431) ISO 4217 code (P498) [sparql 307/TRY2x; 28Nov2022]
Category:ISO 4217 Category:Pages using ISO 4217 currency to check‎ (0) Category:Pages using Infobox currency with unknown parameters (0) Category:Pages using Infobox currency to check (30) Category:Redirects from ISO 4217 codes (191) Category:Redirects from obsolete ISO 4217 codes (116)

Template:ISO 4217/code/doc

Contents

General

Base: iso-code

ISO 4217/code

iso-code error (maintenance category)

option-none (code='None')

Examples

Derived value templates

minor unit

Ambiguous code & minor units

code-to-number

code-is-ambiguous

code-to-withdrawal-date

Not in mainspace

code-is-obsolete

The logic

Contradiction solving

Examples

code-entity-list

code-count

code-to-qid

Maintenance-category (ISO 4217)

Backoffice

The templates

todo

See also