View source for Template:Format price/doc

{{Documentation subpage}}
This template display 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 received separators and exactly two digits to represent cents, what doesn't always happen with the <tt><nowiki>{{formatnum:}}</nowiki></tt> [[Help:Magic words|magic word]].

=== Usage ===

 {{tlx|Formatprice|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.

==== Examples ====

* {{aye}} {{tlx|Formatprice|1.2}} = {{Formatprice|1.2}}
* {{aye}} {{tlx|Formatprice|456.789}} = {{Formatprice|456.789}}
* {{aye}} {{tlx|Formatprice|456.789|1}} = {{Formatprice|456.789|1}}
* {{aye}} {{tlx|Formatprice|456.789|0}} = {{Formatprice|456.789|0}}
* {{aye}} {{tlx|Formatprice|456.789|-2}} = {{Formatprice|456.789|-2}}
* {{aye}} <tt>'''$'''{{tlx|Formatprice|1234}}</tt> = ${{Formatprice|1234}}
* {{aye}} <tt>'''$'''{{tlx|Formatprice|12345}}</tt> = ${{Formatprice|12345}}
* {{aye}} <tt>'''$'''{{tlx|Formatprice|123456}}</tt> = ${{Formatprice|123456}}
* {{aye}} <tt>'''$'''{{tlx|Formatprice|1000000}}</tt> = ${{Formatprice|1000000}}
* {{aye}} <tt>'''¥'''{{tlx|Formatprice|98765432109876}}</tt> = ¥{{Formatprice|98765432109876}}
* {{aye}} <tt>{{tlx|Formatprice|7.86178E+25}} atoms</tt> = {{Formatprice|7.86E+25}} atoms
* {{nay}} {{tlx|Formatprice}} = {{Formatprice}}
* {{nay}} {{tlx|Formatprice|{{!}}0}} = {{Formatprice||0}}
* {{nay}} {{tlx|Formatprice|-100}} = {{Formatprice|-100}}
* {{nay}} {{tlx|Formatprice|xyz|A}} = {{Formatprice|xyz|A}}

=== See also ===

* {{tl|Inflation}}
* {{tl|Inflation-fn}}

<includeonly>
{{DEFAULTSORT:{{BASEPAGENAME}}}}
[[Category:Currency]]
[[Category:Currency conversion templates]]
[[Category:Economics templates]]
[[Category:Finance templates]]
[[Category:Miscellaneous templates]]
</includeonly>