Template:To USD round/doc: Difference between revisions
→Syntax: Wlink significant figures. |
mNo edit summary |
||
(20 intermediate revisions by 9 users not shown) | |||
Line 1: | Line 1: | ||
{{documentation subpage}} |
{{documentation subpage}} |
||
{{tsh|USDr|To USD r|ToUSDr}} |
|||
This template converts a value given in the national currency of a given country to a round [[United States dollar|US dollar]] figure. The intended use is for large round figures, when you don't want 3.2 million |
This template converts a value given in the national currency of a given country to a round [[United States dollar|US dollar]] figure. The intended use is for large round figures, when you don't want {{euro|3.2 million}} turning into {{US$|{{To USD|3200000|FRA}}}}, you just want a round figure like {{US$|{{To USD round|3200000|FRA}}}}. It tries to mimic the same number of significant figures as are present in the original amount. The template uses values published by the [[International Monetary Fund|IMF]].<ref>{{cite web|url=http://data.worldbank.org/indicator/PA.NUS.FCRF|title=Official exchange rate (LCU per US$, period average)|accessdate = 14 April 2013}}</ref> |
||
=== |
=== Usage === |
||
<code><nowiki>{{</nowiki>To USD round|''AMOUNT''|''COUNTRY''|''YEAR''|sf=''SIGFIG''<nowiki>}}</nowiki></code> |
<code><nowiki>{{</nowiki>To USD round|''AMOUNT''|''COUNTRY''|''YEAR''|sf=''SIGFIG''<nowiki>}}</nowiki></code> |
||
=== Parameters === |
|||
⚫ | |||
There are three [[WP:PARAMETER|unnamed parameters]], and one named parameter: |
|||
⚫ | |||
⚫ | |||
⚫ | |||
* ''SIGFIG'' (optional) is a numerical value. If present, the converted value is displayed to the that number of [[significant figures]]. The default is the number of significant figures in ''AMOUNT''. |
|||
⚫ | |||
⚫ | |||
* {{para|sf}} is number of [[significant figures]]. The converted value is displayed to that precision. Optional; the default is the number of significant figures in the amount given in param 1. |
|||
===Examples=== |
===Examples=== |
||
*<code><nowiki>{{To USD round|5200|Mexico}}</nowiki></code> displays {{To USD round|5200|Mexico}}. That is, 5200 [[Mexican peso]]s would exchange to ''roughly'' {{To USD round|5200|MEX}} [[United States dollar |
*<code><nowiki>{{To USD round|5200|Mexico}}</nowiki></code> displays {{To USD round|5200|Mexico}}. That is, 5200 [[Mexican peso]]s would exchange to ''roughly'' {{To USD round|5200|MEX}} [[United States dollar|US dollars]] (to two significant digits) at the 2019 exchange rate. |
||
* |
* {{tlg|To USD round|5200|MEX|code=1|_show_result=1}} |
||
* |
* {{tlg|To USD round|1250|FRA|code=1|_show_result=1}} |
||
* |
* {{tlg|To USD round|5200|MEX|sf=3|code=1|_show_result=1}} |
||
* <code><nowiki>{{Formatnum:{{To USD round| |
* <code><nowiki>{{Formatnum:{{To USD round|185000|RUS}}}}</nowiki></code> ⟶ {{Formatnum:{{To USD round|1850000|RUS}}}}. |
||
* <code><nowiki>{{To USD round|5200|MEX|year= |
* <code><nowiki>{{To USD round|5200|MEX|year=1998}}</nowiki></code> displays {{To USD round|5200|MEX|year=1998}} since data for 1998 has not been defined. It will add the page to [[:Category:Pages using an undefined year in {{ARTICLEPAGENAME}}]] |
||
* <code><nowiki>{{To USD round|5200|MEX|year=2009}}</nowiki></code> displays {{To USD round|5200|MEX|year=2009}} since data for 2009 has not been entered for Mexico. It will add the page to [[:Category:Pages using an undefined country code in {{ARTICLEPAGENAME}}]] |
|||
---- |
---- |
||
* |
* {{tlg|To USD round|586000|BRA|year{{=}}2011|code=1|_show_result=1}} |
||
* |
* {{tlg|To USD round|586000|BRA|year{{=}}2019|code=1|_show_result=1}} |
||
* |
* {{tlg|To USD round|586000|BRA|year{{=}}|code=1|_show_result=1}} |
||
* |
* {{tlg|To USD round|586000|BRA|code=1|_show_result=1}} |
||
* {{tlg|To USD round|620000000|BRA|year{{=}}2015|code=1|_show_result=1}} |
|||
⚫ | |||
* {{tlg|To USD round|620000000|BRA|year{{=}}2015|sf{{=}}4|code=1|_show_result=1}} |
|||
⚫ | |||
===See also=== |
===See also=== |
||
Line 31: | Line 38: | ||
* [[Template:Round]] |
* [[Template:Round]] |
||
* [[Template:significant figures]] |
* [[Template:significant figures]] |
||
* [[Template:International dollars]]: Converts a value in a given country in a given year to [[Geary–Khamis dollar |
* [[Template:International dollars]]: Converts a value in a given country in a given year to [[Geary–Khamis dollar|international dollars]]. |
||
* [[Template:Per capita]] |
|||
* {{tlc|[[Help:Parser functions|formatnum:]]}} |
* {{tlc|[[Help:Parser functions|formatnum:]]}} |
||
===Data subtemplates=== |
===Data subtemplates=== |
||
{{excerpt|Template:To USD/doc|Data subtemplates|hat=no}} |
|||
{{hlist| [[Template:To USD/data/2002|2002]] | [[Template:To USD/data/2011|2011]] | [[Template:To USD/data/2012|2012]] | [[Template:To USD/data/2013|2013]] | [[Template:To USD/data/2014|2014]] | [[Template:To USD/data/2015|2015]] | [[Template:To USD/data/2016|2016]] | [[Template:To USD/data/2017|2017]] | [[Template:To USD/data/2018|2018]] }} |
|||
===References=== |
===References=== |
||
Line 41: | Line 49: | ||
<!-- ADD CATEGORIES BELOW THIS LINE --> |
<!-- ADD CATEGORIES BELOW THIS LINE --> |
||
<includeonly> |
<includeonly>{{Sandbox other|| |
||
{{DEFAULTSORT:{{BASEPAGENAME}}}} |
{{DEFAULTSORT:{{BASEPAGENAME}}}} |
||
[[Category:Currency conversion templates]] |
[[Category:Currency conversion templates]] |
||
</includeonly> |
}}</includeonly> |
||
==TemplateData== |
==TemplateData== |
||
{{TemplateDataHeader}} |
{{TemplateDataHeader}} |
||
Line 68: | Line 77: | ||
}, |
}, |
||
"year": { |
"year": { |
||
"description": "Year to convert currency. Values: |
"description": "Year to convert currency. Values: 1960–2022.", |
||
"example": "2002", |
"example": "2002", |
||
"type": "number", |
"type": "number", |
||
"default": "2019", |
|||
"required": false |
"required": false |
||
}, |
}, |
||
"sf": { |
"sf": { |
||
"label": " |
"label": "significant figures", |
||
"description": "If numeric, rounds to that many significant figures. If omitted, rounds to number of significant figures in 'amount'.", |
"description": "If numeric, rounds to that many significant figures. If omitted, rounds to number of significant figures in 'amount'.", |
||
"example": "3", |
"example": "3", |
Latest revision as of 11:03, 7 August 2024
This is a documentation subpage for Template:To USD round. It may contain usage information, categories and other content that is not part of the original template page. |
This template converts a value given in the national currency of a given country to a round US dollar figure. The intended use is for large round figures, when you don't want €3.2 million turning into US$3,784,640, you just want a round figure like US$3,600,000. It tries to mimic the same number of significant figures as are present in the original amount. The template uses values published by the IMF.[1]
Usage
[edit]{{To USD round|AMOUNT|COUNTRY|YEAR|sf=SIGFIG}}
Parameters
[edit]There are three unnamed parameters, and one named parameter:
|1=
is the amount in local currency to be converted to US dollars. Required.|2=
is the name or 3-letter ISO code of the country whose currency is being converted. Required.|3=
is the year to use for the US dollar exchange rate against the currency of the other country. Possible values: see § Data subtemplates below. Optional; default =2019
.|sf=
is number of significant figures. The converted value is displayed to that precision. Optional; the default is the number of significant figures in the amount given in param 1.
Examples
[edit]{{To USD round|5200|Mexico}}
displays 270. That is, 5200 Mexican pesos would exchange to roughly 270 US dollars (to two significant digits) at the 2019 exchange rate.{{To USD round|5200|MEX}}
→ 270{{To USD round|1250|FRA}}
→ 1,400{{To USD round|5200|MEX}}
→ 270{{Formatnum:{{To USD round|185000|RUS}}}}
⟶ 28,600.{{To USD round|5200|MEX|year=1998}}
displays Undefined year "1998" since data for 1998 has not been defined. It will add the page to Category:Pages using an undefined year in Template:To USD round/doc{{To USD round|5200|MEX|year=2009}}
displays 380 since data for 2009 has not been entered for Mexico. It will add the page to Category:Pages using an undefined country code in Template:To USD round/doc
{{To USD round|586000|BRA|year=2011}}
→ 350,000{{To USD round|586000|BRA|year=2019}}
→ 149,000{{To USD round|586000|BRA|year=}}
→ 149,000{{To USD round|586000|BRA}}
→ 149,000{{To USD round|620000000|BRA|year=2015}}
→ 190,000,000{{To USD round|620000000|BRA|year=2015|sf=4}}
→ 186,400,000{{To USD round|640|MEX|sf=5}}
→ 33.220 # Some combos make no sense; USD doesn't have tenths of a cent.
See also
[edit]- Template:US$
- Template:Inflation: Calculates a value in a given country in a given year based on an amount of currency in the same country in another year.
- Template:To USD
- Template:Round
- Template:significant figures
- Template:International dollars: Converts a value in a given country in a given year to international dollars.
- Template:Per capita
{{formatnum:}}
Data subtemplates
[edit]References
[edit]- ^ "Official exchange rate (LCU per US$, period average)". Retrieved 14 April 2013.
TemplateData
[edit]TemplateData for To USD round
Template to convert other currencies into United States dollars, by year, based on information from the International Monetary Fund, and with selected number of significant figures
Parameter | Description | Type | Status | |
---|---|---|---|---|
amount | 1 | value in foreign currency to convert to USD
| Number | required |
country code | 2 country | ISO 3166-1 alpha-3 country code
| Line | required |
year | year | Year to convert currency. Values: 1960–2022.
| Number | optional |
significant figures | sf | If numeric, rounds to that many significant figures. If omitted, rounds to number of significant figures in 'amount'.
| Number | optional |