Template:Format price/doc
 |
This is a documentation subpage for Template:Format price. It contains usage information, categories and other content that is not part of the original template page. |
This template displays numbers typically representing prices in a pleasant way, ideally suited for articles. Numbers one thousand or greater are reduced down and rounded to a total of three digits followed by a multiplier text, and smaller numbers receive separators and exactly two digits to represent cents, which does not always happen with the {{formatnum:}} magic word.
Contents
Usage[edit]
{{Format price|value|digits}}
Where:
- value: the value that will be formatted and displayed (required).
- digits: sets the digit in which a value lower than one thousand must be rounded, defaulting to "2" (cents) if unspecified.
Providing non-numeric parameters, failing to provide any parameter, or providing a negative value parameter, result all in a link to the NaN article. Despite its name, this template only handles the number-formatting, not any unit symbols – consider {{currency}} for that separate feature.
Examples[edit]
-
{{Format price|1.2}}= 1.20 -
{{Format price|456.789}}= 456.79 -
{{Format price|456.789|1}}= 456.80 -
{{Format price|456.789|0}}= 457 -
{{Format price|456.789|-2}}= 500 -
$<code>{{Format price|1234}}</code> = $1,234 -
$<code>{{Format price|12345}}</code> = $12,345 -
$<code>{{Format price|123456}}</code> = $123,456 -
$<code>{{Format price|1000000}}</code> = $1 million -
¥<code>{{Format price|98765432109876}}</code> = ¥98.8 trillion -
<code>{{Format price|7.86178E+25}}atoms</code> = 78.6 septillion atoms
Wrong[edit]
-
{{Format price}}= Format price error: cannot parse value "" (empty parameter) -
{{Format price||0}}= Format price error: cannot parse value "" (empty first parameter) -
{{Format price|-100}}= Format price error: cannot parse value "-100" (negative values are invalid) -
{{Format price|xyz|A}}= Format price error: cannot parse value "xyz" (only numeric values are allowed) -
{{Format price|1E+309}}= Format price error: cannot parse value "1E+309" (overflow)
See also[edit]
- {{Inflation}}
- {{Inflation/fn}}
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| value | 1 | the value that will be formatted and displayed
| Number | required |
| digits | 2 | sets the digit in which a value lower than one thousand must be rounded, defaulting to "2" (cents) if unspecified
| Number | suggested |
