Template:US$/doc

From Wikipedia, the free encyclopedia
Jump to: navigation, search

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[edit]

{{US$|value}}

Example:

  • {{US$}}US$
  • {{US$|123.45}}US$123.45

Link[edit]

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"[edit]

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[edit]

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 < 2017), the equivalent value represented in 2017 dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.

  • {{US$|value|year}}
  • {{US$|value|year|round=round|about=yes}}

Examples:

  • {{US$|100|1799}}US$100
  • {{US$|100|1800}}US$100 (equivalent to $1,442 in 2017)
  • {{US$|100|1966}}US$100 (equivalent to $754.26 in 2017)
  • {{US$|100|1966|link=yes}}US$100 (equivalent to $754.26 in 2017)
  • {{US$|100|2016}}US$100 (equivalent to $101.97 in 2017)
  • {{US$|100|2017}}US$100
  • {{US$|100|2018}}US$100
  • {{US$|100|2019}}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 $178.50 in 2017)
  • {{US$|10|1935|round=0}}US$10 (equivalent to $178 in 2017)
  • {{US$|10|1935|about=yes}}US$10 (equivalent to about $178 in 2017)
  • {{US$|1000|1935|round=2}}US$1,000 (equivalent to $17,849.51 in 2017)
  • {{US$|1000|1935|round=-2}}US$1,000 (equivalent to $17,800 in 2017)
  • {{US$|1000|1935|round=-2|about=yes}}US$1,000 (equivalent to about $17,800 in 2017)

Redirects here[edit]

See also[edit]