Template:US$
US$
This is a multifunction template. At its simplest, it adds the currency mark "US$", as recommended by MOS:CURRENCY for many situations. The template can also link to the United States dollar article and can even calculate inflation. See warnings below.
Usage
[change source]{{US$|value}}
Example:
{{US$}}
→ US${{US$|123.45}}
→ US$123.45
Link
[change source]The parameter |link=yes
may be used to link US$ to the article United States dollar. This is turned off by default, but may be appropriate for the first occurrence of the term in an article.
Example:
{{US$|123.45|link=yes}}
→ US$123.45
Suppress "US"
[change source]By specifying |long=no
, display of "US" before the "$" sign may be suppressed when it is clear from context that the United States dollar is meant, rather than one of the twenty or so other currencies going by the name of "dollar".
Examples:
{{US$|123.45|long=no}}
→ $123.45{{US$|123.45|long=no|link=yes}}
→ $123.45
Inflation calculation
[change source]Do not assume that using this template will mean that a calculated value is "current", "as of 2024", "as of 2023" or even necessarily "recent". Do not use {{CURRENTYEAR}} to refer to calculated value, instead {{Inflation/year|US}} may be used. See also MOS:REALTIME. |
The template supports inflation calculation, by way of {{Inflation}}
. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, if 1800 ≤ year
< 2021), the equivalent value represented in 2021 dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.
Examples:
{{US$|100|1799}}
→ US$100{{US$|100|1800}}
→ US$100 (equivalent to $1,597 in 2021){{US$|100|1966}}
→ US$100 (equivalent to $835.18 in 2021){{US$|100|1966|link=yes}}
→ US$100 (equivalent to $835.18 in 2021){{US$|100|2020}}
→ US$100 (equivalent to $104.71 in 2021){{US$|100|2021}}
→ US$100{{US$|100|2024}}
→ US$100{{US$|100|2025}}
→ US$100
Additional parameter |about=yes
will cause the template to calculate to the nearest dollar (instead of the nearest cent), and prefix the calculated value with "about". The rounding can be fine-tuned further by using |round=integer
. These parameters may be combined.
Examples:
{{US$|10|1935}}
→ US$10 (equivalent to $197.65 in 2021){{US$|10|1935|round=0}}
→ US$10 (equivalent to $198 in 2021){{US$|10|1935|about=yes}}
→ US$10 (equivalent to about $198 in 2021){{US$|1000|1935|round=2}}
→ US$1,000 (equivalent to $19,764.56 in 2021){{US$|1000|1935|round=-2}}
→ US$1,000 (equivalent to $19,800 in 2021){{US$|1000|1935|round=-2|about=yes}}
→ US$1,000 (equivalent to about $19,800 in 2021)