Template:To USD/doc

From the AARoads Wiki: Read about the road before you go
Jump to navigation Jump to search

This template converts a value given in the national currency of a given country to US dollars. The template uses values published by the IMF,[1] as well as by the World Bank,[2] the European Central Bank,[3] Eurostat,[4] and the Reserve Bank of India.

Syntax

{{To USD | {{{1}}} | {{{2}}} | year = {{{year}}} | round = {{{round}}} | r = {{{r}}} | cur = {{{cur}}} }}

  • {{{1}}} and {{{2}}} are the template positional parameters (this is, the first and the second parameters in the template).
    • {{{1}}} is the value in the local currency to be converted.
    • {{{2}}} is the country name or 3-letter ISO code for the country whose currency is being converted.
  • {{{year}}} is the year to use for the US dollar value, e.g. US dollars current in 2009. The default is currently 2021.
  • {{{round}}} is an optional parameter. If it is equal to "yes", then the converted value is displayed to the nearest US dollar. The default is rounding to the nearest penny.
  • {{{r}}} is an optional parameter. It sets the digits to which the result must be rounded. A positive value indicates a fractional digit including trailing zeros. Defaults to 2.
  • {{{cur}}} is an optional parameter. It allows to select the currency for the country. Currently only supported for the Euro and the currencies that have been immediately replaced by the Euro.

Examples

  • {{To USD|100|Mexico}} displays 4.93. That is, 100 Mexican pesos would exchange to 4.93 US dollars.
  • {{To USD|100|MEX}} also displays 4.93.
  • {{To USD|100|MEX|round=yes}} displays 5.
  • {{To USD|100|FRA}} displays 118.27. That is, 100 Euros (the currency used in France) is currently 118.27 US dollars.
  • {{Formatnum:{{To USD|100000|RUS}}}} displays 1,357.77.
  • {{To USD|100|MEX|year=1959}} displays Undefined year "1959" since data for 1959 has not yet been defined. It will add the page to Category:Pages using an undefined year in Template:To USD

See also

Data subtemplates

References

  1. ^ "Official exchange rate (LCU per US$, period average)". Retrieved 14 April 2013.
  2. ^ "The World Bank exchange rate, DEC alternative conversion factor (LCU per US$)". Retrieved 31 December 2019.
  3. ^ "Reference rates - Exchange rates - ECB Statistical Data Warehouse".
  4. ^ "Eurostat Database".

Tracking categories


TemplateData

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

TemplateData for To USD

<templatedata> { "params": { "1": { "label": "Amount", "description": "value in foreign currency to convert to USD", "example": "22816", "type": "number", "required": true }, "2": { "aliases": [ "country" ], "label": "Country code", "description": "ISO 3166-1 alpha-3 country code", "example": "MEX", "type": "line", "required": true }, "year": { "description": "Year to convert currency", "example": "2002", "type": "number", "required": true }, "round": { "label": "Round to nearest dollar?", "description": "If 'yes', rounds to nearest whole dollar amount. If omitted, rounds to nearest US cent.", "example": "yes", "type": "string" }, 

               "r": {

"label": "Resolution", "description": "The number of digits of precision in the result value.", "example": "3", "type": "number" }, 

               "cur": {

"label": "Currency code", "description": "It allows to select the currency for the country. Currently only supported for the Euro and the currencies that have been immediately replaced by the Euro.", "example": "FRF, EUR", "type": "line" } }, "description": "Template to convert other currencies into United States dollars, by year, based on information from the International Monetary Fund" } </templatedata>

Retrieved from "https://wiki.aaroads.com/w/index.php?title=Template:To_USD/doc&oldid=255920"