Template:US$

From Timelines
Jump to: navigation, search

US$

Template documentation[view] [edit] [history] [purge]

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

{{US$|value}}

Example:

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

Link

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

Inflation calculation

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 < 2016), the equivalent value represented in 2016 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,411 in 2016)
  • {{US$|100|1966}}US$100 (equivalent to $738.15 in 2016)
  • {{US$|100|1966|link=yes}}US$100 (equivalent to $738.15 in 2016)
  • {{US$|100|2015}}US$100 (equivalent to $101.04 in 2016)
  • {{US$|100|2016}}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 $174.68 in 2016)
  • {{US$|10|1935|round=0}}US$10 (equivalent to $175 in 2016)
  • {{US$|10|1935|about=yes}}US$10 (equivalent to about $175 in 2016)
  • {{US$|1000|1935|round=2}}US$1,000 (equivalent to $17,468.45 in 2016)
  • {{US$|1000|1935|round=-2}}US$1,000 (equivalent to $17,500 in 2016)
  • {{US$|1000|1935|round=-2|about=yes}}US$1,000 (equivalent to about $17,500 in 2016)

Redirects here

See also