Template:Format price/doc

From CWS Planet
Jump to navigation Jump to search

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.

Usage

{{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

Wrong

See also


No description.

Template parameters

ParameterDescriptionTypeStatus
value1

the value that will be formatted and displayed

Example
1,000
Numberrequired
digits2

sets the digit in which a value lower than one thousand must be rounded, defaulting to "2" (cents) if unspecified

Numbersuggested