Template:US$/doc
 | This is a documentation subpage for Template:US$. It contains usage information, categories and other content that is not part of the original template page. |
This template adds the currency mark "US$" linked to the United States dollar article.
Usage
{{US$|value}} (value must be specified)
Example:
- REDIRECT Template:Template link code produces US$123.45
Inflation calculation
 |
This template is only capable of inflating Consumer Price Index values: staples, workers rent, small service bills (doctor's costs, train tickets). This template is incapable of inflating Capital expenses, government expenses, or the personal wealth and expenditure of the rich. Incorrect use of this template would constitute original research. If you yourself do not possess it, please consult someone with economic training before making use of this. |
The template supports calculation of inflation. A second parameter can be used to specify a year from 1800 onwards and the relative value in 2024 will be calculated.
Examples:
- REDIRECT Template:Template link code → US$10
- REDIRECT Template:Template link code → US$10 (equivalent to $125.14 in 2020)
- REDIRECT Template:Template link code → US$10 (equivalent to $10 in 2020)
A third 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:
- REDIRECT Template:Template link code → US$10 (equivalent to $155.28 in 2020)
- REDIRECT Template:Template link code → US$10 (equivalent to about $155 in 2020)
- REDIRECT Template:Template link code → US$10 (equivalent to $155 in 2020)
- REDIRECT Template:Template link code → US$1,000 (equivalent to $15,527.98 in 2020)
- REDIRECT Template:Template link code → US$1,000 (equivalent to $15,500 in 2020)
- REDIRECT Template:Template link code → US$1,000 (equivalent to about $15,500 in 2020)
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:
- REDIRECT Template:Template link code → US$10 (equivalent to $155.28 in 2020)