Permanently protected template

Template:US$

From Wikipedia, the free encyclopedia
Jump to navigation Jump to 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

Suppress "US"

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

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 < 2019), the equivalent value represented in 2019 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,506 in 2019)
  • {{US$|100|1966}}US$100 (equivalent to $788 in 2019)
  • {{US$|100|1966|link=yes}}US$100 (equivalent to $788 in 2019)
  • {{US$|100|2018}}US$100 (equivalent to $101.82 in 2019)
  • {{US$|100|2019}}US$100
  • {{US$|100|2020}}US$100
  • {{US$|100|2021}}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 $186.48 in 2019)
  • {{US$|10|1935|round=0}}US$10 (equivalent to $186 in 2019)
  • {{US$|10|1935|about=yes}}US$10 (equivalent to about $186 in 2019)
  • {{US$|1000|1935|round=2}}US$1,000 (equivalent to $18,648.06 in 2019)
  • {{US$|1000|1935|round=-2}}US$1,000 (equivalent to $18,600 in 2019)
  • {{US$|1000|1935|round=-2|about=yes}}US$1,000 (equivalent to about $18,600 in 2019)
Caution

The inflation-calcuation code causes this template to approach the 40-deep expansion depth limit in the software that makes Wikipedia work. Pages that exceed this limit are placed in Category:Pages where expansion depth is exceeded. Using |about=yes can reduce the impact somewhat. If you call this template from within another template and use the inflation feature, consider adding a caution similar to this one to the that template's documention page.

Redirects here

See also

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Amount1

Amount in US$

Numberrequired
Year2

Specify a year and, if this year is between 1800 and the current year minus 1, the inflation-adjusted value will be calculated in parentheses

Numbersuggested
Link?link

Link US$ to article

Example
yes
Booleansuggested
About?about

If yes, calculate to the nearest dollar (instead of the nearest cent) and prefix the calculated value with "about"

Example
yes
Booleanoptional
Decimal pointsround

Integer, where round to number of decimal points specified, use negative (for example, -2) for significant figures

Example
2
Numbersuggested
US$?long

If no, display of "US" before the "$" sign will 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".

Example
no
Booleanoptional