Template:US$/doc

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 in.

Usage
Additional text like "million" or "trillion" must be placed outside the template, typically preceded by a non-breaking space (see example below).

Example:
 * → US$
 * → US$123.45
 * → US$123million

Link
The parameter 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

Suppress "US"
By specifying 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
 * → US$123.45

Inflation calculation
The template supports inflation calculation, by way of. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, if ≤  <), the equivalent value represented in  dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.



Examples:
 * → US$100
 * → US$100
 * → US$100 1966
 * → US$100 1966
 * → US$100
 * → US$100
 * → US$100 2024
 * → US$100

Additional parameter 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 integer. These parameters may be combined.

Examples:
 * → US$10 1935
 * → US$10 1935
 * → US$10 1935
 * → US$1000 1935
 * → US$1000 1935
 * → US$1000 1935


 * Caution
 * The inflation-calculation 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 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 that template's documention page.

Show year
The parameter yes may be used to show  between the amount and the inflation convertion. This is used for sentence structuring.

Example:
 * → US$100 1850
 * → US$100 1850

Redirects here

 * Template:USD

Template data
{	"params": { "1": {			"label": "Amount", "description": "Amount in US$", "type": "number", "required": true },		"2": {			"label": "Year", "description": "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", "type": "number", "suggested": true },		"link": { "label": "Link?", "description": "Link US$ to article", "example": "yes", "type": "boolean", "suggested": true },		"about": { "label": "About?", "description": "If yes, calculate to the nearest dollar (instead of the nearest cent) and prefix the calculated value with \"about\"", "example": "yes", "type": "boolean" },		"round": { "label": "Decimal points", "description": "Integer, where round to number of decimal points specified, use negative (for example, -2) for significant figures", "example": "2", "type": "number", "suggested": true },		"long": { "label": "US$?", "description": "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", "type": "boolean" },		"showyear": { "label": "Show year?", "description": "If yes, show 'in YYYY' between the amount and the inflation calculation", "example": "yes", "type": "boolean" }	},	"description": "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.", "format": "inline", "paramOrder": [ "1",		"2",		"link", "about", "round", "long", "showyear" ] }