Template:Currency/sandbox

This is the template sandbox page for Template:Currency (diff).
See also the companion subpage for test cases.

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 4,300 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

Preview message: Transclusion count updated automatically (see documentation).

This template uses Lua:

Formats a currency value with the appropriate symbol which is linked to the article about the currency. If no currency is specified, the template will show the amount in United States dollars.

Usage

Using unnamed parameters:

{{currency|value|code|first=|linked=|fmt=|passthrough=}}

Using named parameters:

{{currency|amount=value|code=code|first=|linked=|passthrough=}}

where:

value is a number with or without comma separators; may be followed by an optional quantifier: 'thousand', 'million', 'M', 'billion', 'B', or 'trillion'.

code is an ISO 4217 currency code or one of the supported non-standard codes listed below.

|first= when set to any value produces a long-form currency name

|linked= when set to no disables wikilinks on the rendered currency symbol or long-form currency name

|fmt= specifies how value digit-groups are separated:

commas (default) separates value digit-groups with commas; this is the default, same as when |fmt= is empty or omitted

gaps separates value digit-groups with narrow gaps.

none renders value without digit grouping.

|passthrough= specifies whether or not the template should attempt to parse the number according to |fmt= or just put whatever string is provided in |amount= directly after the currency sign. Should have value of either |passthrough=yes or |passthrough=no

Note: Using both named and unnamed parameters may produce unexpected results. In this example, the template expects the first unnamed parameter to be a value number:

{{Currency|amount=1000|GBP}}

{{currency}} – invalid amount (help)

use {{Currency|1000|GBP}} or {{Currency|amount=1000|code=GBP}}, which both yield £1,000 .

Supported non-standard currency codes

Codes that can be translated to ISO 4217 currencies

These non-standard codes are aliases of standard ISO 4217 codes.

EGE
EU
EURO
FRW
KSH
NEP
POUND
POUND STERLING
RMB
STERLING
STG
TSH
UK
UNITED STATES
US
U.S.
USA
USH

Other non-standard codes

These codes either do not have a matching ISO 4217 currency code or are alternate versions of existing ISO 4217 codes or support unique aspects of a currency.

BITCOIN – no matching ISO 4217 code
BTC – no matching ISO 4217 code
DKK2 – alternate version of DKK
FRF – historical
GRD – historical
LSL2 – plural version of LSL
LTL – historical
NOK2 – alternate version of NOK
SEK2 – alternate version of SEK
SZL2 – plural version of SZL
US$ - special case: like the standard codes "USD" (and "$"), but only displays "$" instead of the longer "US$" (for articles where displaying "US$" might appear inappropriately long, but the template should still link to "United States dollar" to avoid any ambiguity)
XBT – no matching ISO 4217 code

Examples

Currencies other than the United States dollar can be rendered by using the appropriate ISO 4217 currency code

{{Currency|1000|BMD}} gives: BD$1,000 for the Bermudian dollar
{{Currency|1000|BDT}} gives: ৳1,000 for the Bangladeshi taka
{{Currency|1000|AMD}} gives: ֏ 1,000 for the Armenian dram

Some of the more well known currencies also provide the ability to use common abbreviations or full names.

{{Currency|1000|US}} gives: US$1,000
{{Currency|1000|United States}} gives: US$1,000
{{Currency|1,000|JPY}} gives: ¥1,000

Parameter names can also be used, if preferred:

{{Currency|amount=1000|code=US}} gives: US$1,000
{{Currency|1000|code=euro}} gives: €1,000

Negative amount:

{{Currency|amount=-1000|code=US}} gives: US$−1,000

Text quantifiers:

{{Currency|1000 million|code=euro}} gives: €1,000,000,000
{{Currency|1000M|code=euro}} gives: €1,000,000,000

The first use of a currency should show the value and the full name of the currency, so if the "first" parameter is defined then that is what will be given.

{{Currency|1000|cve|first=yes}} gives: 1,000 Cape Verde escudos
{{Currency|1000|cve}} gives: 1.000$00

Because the symbol for the currencies DKK, NOK, and SEK may be ambiguous, these may be represented in two ways:

For DKK:
{{Currency|1000|dkk}} gives: kr. 1,000

{{Currency|1000|dkk2}} gives: DKK 1,000
For NOK:
{{Currency|1000|NOK}} gives: kr 1,000

{{Currency|1000|NOK2}} gives: NOK 1,000
For SEK:
{{Currency|1000|SEK}} gives: kr 1,000

{{Currency|1000|SEK2}} gives: SEK 1,000

Similarly, some currencies use different symbols for single and plural amounts:

{{Currency|1|LSL}} gives: L1

{{Currency|1000|LSL2}} gives: M1,000
The template does not currently make this distinction automatically so it is the responsibility of the editor using these kinds of codes to get the code right.

Digit grouping:

|fmt=commas
{{Currency|1000 million|code=euro|fmt=commas}} gives: €1,000,000,000
|fmt=gaps
{{Currency|1000 million|code=euro|fmt=gaps}} gives: €1000000000
|fmt=none
{{Currency|1000 million|code=euro|fmt=none}} gives: €1000000000

Passthrough:

|passthrough=yes
{{Currency|6 million|PHP|passthrough=yes}} gives: ₱6 million

{{Currency|6 trillion|PHP|passthrough=yes}} gives: ₱6 trillion

{{Currency|6 tn|PHP|passthrough=yes}} gives: ₱6 tn
|passthrough=no
{{Currency|6 million|PHP|passthrough=no}} gives: ₱6,000,000

{{Currency|6 trillion|PHP|passthrough=no}} gives: ₱6,000,000,000,000

{{Currency|6 tn|PHP|passthrough=no}} gives: {{currency}} – invalid amount (help) (error expected, as template doesn't know how to parse 6 tn to 6,000,000,000,000)
Use sparingly! Usually you want |fmt= instead. |passthrough= should only be used in ways compatible with MOS:CURRENCY.

Error messages

{{currency}} can produce several error message. These are:

{{currency}} – invalid code – the value in the second unnamed parameter or assigned to |code= cannot be found in the template's list of codes. Make sure that the assigned code is a correct ISO 4217 currency code or one of the supported non-standard codes listed above.
{{currency}} – invalid amount – the value in the first unnamed parameter or assigned to |amount= contains one or more characters that is not a minus sign, a digit, comma, or decimal point, or has some text that is not one of the permitted quantifiers. Make sure that comma separators group three digits and that the number has only one decimal point. Make sure that the amount and code parameters are either both named (|amount= and |code=) or both unnamed.
{{currency}} – definition missing position – an internal error that should only occur when an editor is mucking about in Module:Currency/Presentation. It indicates that Module:Currency doesn't know where to place the currency's symbol in relation to its value.
{{currency}} – definition missing page – an internal error that should only occur when an editor is mucking about in Module:Currency/Presentation. It indicates that Module:Currency doesn't have a page that it can use to link the currency's symbol or name.

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Currency in articles based on its TemplateData.

TemplateData for Currency

Use this template to provide a linked currency symbol and the amount of cash.

Template parameters[Edit template data]
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Amount	`1` `amount` `Amount`	The value in the given currency	Line	required
Currency	`2` `code` `type` `Type`	The currency represented. Should be a valid ISO 4217 code or one of the special codes listed on the template’s page Default USD Example USD	Line	suggested
Long form	`first`	When set to any value, produces a long-form currency name. This should be used for the first mention of a currency within the article	Line	optional
Link currency	`linked`	Whether to link to the article on that currency. “no” suppresses the link, any other value displays it Default yes Example no	Line	optional
Format	`fmt`	Specifies how value digit-groups are separated: commas, gaps or none Default commas Example gaps	Line	optional
Passthrough	`passthrough`	If "yes", put the string in Amount directly after its symbol without turning it into a number. Default no Example yes	Line	optional