Difference between revisions of "Template:Currency/old/doc"

From blackwiki
Jump to navigation Jump to search
imported>Margin1522
(consistently add space after "gives:" like 1st example. Debatable as template result (template doesn't add a space), but better writing style.)
imported>Margin1522
(make 1st column of table wider (15em) for better display of parameter names)
Line 11: Line 11:
 
! Name !! Meaning
 
! Name !! Meaning
 
|-
 
|-
| amount, Amount,<br>or the first unnamed param || The value to use to format as a currency number
+
|style="width:15em;"| amount, Amount,<br>or the first unnamed parameter || The value to format as a currency number
 
|-
 
|-
 
| type, Type,<br>or the second unnamed parameter || The type of currency to format the value as.<br>Most currencies are available through the use of the appropriate [[ISO 4217|ISO 4217 currency code]]. Some of the more popular currencies are also available by using the full name or popular abbreviations.<br>The default value is to format the value as the [[United States dollar]] (US$), in accordance with [[Wikipedia:Manual of Style (dates and numbers)#Currencies|the Manual of Style — Dates and Numbers — Currencies]]
 
| type, Type,<br>or the second unnamed parameter || The type of currency to format the value as.<br>Most currencies are available through the use of the appropriate [[ISO 4217|ISO 4217 currency code]]. Some of the more popular currencies are also available by using the full name or popular abbreviations.<br>The default value is to format the value as the [[United States dollar]] (US$), in accordance with [[Wikipedia:Manual of Style (dates and numbers)#Currencies|the Manual of Style — Dates and Numbers — Currencies]]

Revision as of 08:37, 12 October 2014

Formats a currency value with a link to the page about the currency and the appropriate symbol. The default is to show US$ value.

Usage

  • {{Currency|1000}} gives: US$1,000
Parameters
Name Meaning
amount, Amount,
or the first unnamed parameter
The value to format as a currency number
type, Type,
or the second unnamed parameter
The type of currency to format the value as.
Most currencies are available through the use of the appropriate ISO 4217 currency code. Some of the more popular currencies are also available by using the full name or popular abbreviations.
The default value is to format the value as the United States dollar (US$), in accordance with the Manual of Style — Dates and Numbers — Currencies
first if this parameter is present, with any value given, then the template will return a <value> <currency name> pair instead of the normal <linked symbol><value> pair. This is provided to comply with the first bullet point in the formatting section in the Manual of Style — Dates and Numbers — Currencies

Examples

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

Some of the more well known currencies also provide the ability to use common abbreviations or full names. Note that case shouldn't matter with the parameters, either.

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

Parameter names can also be used, if preferred:

  • {{Currency|amount=1000|type=US}} gives: US$1,000
  • {{Currency|1000|type=us}} gives: {{currency}} – invalid amount (help)
  • {{Currency|Amount=1000|euro}} gives: 1,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|Amount=1000|quid|first=yes}} gives: {{currency}} – invalid code (help)

The Krone currencies can be represented in two ways:

  • {{Currency|1000|NOK}} gives: kr 1,000 - beware of ambiguity with Danish DKK (kr. 1,000) and Swedish SEK (kr 1,000)
  • {{Currency|1000|NOK2}} gives: NOK 1,000

See also