View source for Template:JPY/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{template shortcut|Yen}}

This is a multifunction template. At its simplest, it adds the currency mark "¥", as recommended by [[MOS:CURRENCY]] for many situations. The template can also link to the [[Japanese yen]] article and can even calculate inflation. <em>See warnings below.</em>

== Usage ==
* {{tlxi|¥|number}}
* {{tlxi|JPY|number}}
* {{tlxi|Yen|number}}

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

Example:
* {{tbullet|¥}}
* {{tbullet|¥|123.45}}
*<code><nowiki>{{[[Template:¥|]]|123}}{{nbsp}}million</nowiki></code> → {{¥|123}}{{nbsp}}million

=== Link ===
The parameter {{para|link|yes}} may be used to link ¥ to the article [[Japanese yen]]. This is turned off by default, but may be appropriate for the first occurrence of the term in an article.

Example:
* {{tld|¥|123.45|3=link=yes}} → {{¥|123.45|link=yes}}

=== Inflation calculation ===
{{ombox |type= content |imageright= [[File:Emblem-money.svg|42px]] |text= This template is <strong>only capable</strong> of inflating Consumer Price Index values: staples, workers' rent, small service bills (doctor's costs, train tickets). This template is <strong>incapable</strong> of inflating capital expenses, government expenses, or the personal wealth and expenditure of the rich. <strong>Incorrect use of this template would constitute original research. If you yourself do not have economic training, then please consult someone who does before using this template.</strong>}}
{{ombox |type= content |imageright= [[File:Current event warning.svg|42px]] |text= <strong>Do not assume that using this template will mean that a calculated value is <em>"current"</em></strong>, <em>"as of {{CURRENTYEAR}}"</em>, <em>"as of {{#expr:{{CURRENTYEAR}}-1}}"</em> or even necessarily <em>"recent"</em>. Do not use <code><nowiki>{{CURRENTYEAR}}</nowiki></code> to refer to calculated value, instead {{tlx|Inflation/year|JP}} may be used. See also [[MOS:REALTIME]].}}

The template supports inflation calculation, by way of {{tlx|Inflation}}. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, {{nowrap|if {{Inflation/JP/startyear}} ≤ <code>{{var|year}}</code> < {{Inflation/year|JP}}}}), the equivalent value represented in {{Inflation/year|JP}} yen will be calculated in parentheses. However, this function should only be used in appropriate situations.

* {{tlxi|¥|value|year}}
* {{tlx|¥|{{var|value}}|{{var|year}}|4=round={{var|round}}|5=about=yes}}

Examples:
* {{tbullet|¥|100|{{#expr:{{Inflation/JP/startyear}}-1}}}}
* {{tbullet|¥|100|{{Inflation/JP/startyear}}}}
* {{tbullet|¥|100|1966}}
* {{tld|[[Template:¥|¥]]|100|1966|4=link=yes}} → {{¥|100|1966|link=yes}}
* {{tbullet|¥|100|{{#expr:{{Inflation/year|JP}}-1}}}}
* {{tbullet|¥|100|{{Inflation/year|JP}}}}
* {{tbullet|¥|100|{{CURRENTYEAR}}}}
* {{tbullet|¥|100|{{#expr:{{CURRENTYEAR}}+1}}}}

Additional parameter {{para|about|yes}} will cause the template to calculate to the nearest yen (instead of the nearest sen or rin), and prefix the calculated value with "about". The rounding can be fine-tuned further by using {{para|round|{{var|integer}}}}. These parameters may be combined.

Examples:
* {{tld|¥|10|1966}} → {{¥|10|1966}}
* {{tld|¥|10|1966|4=round=0}} → {{¥|10|1966|round=0}}
* {{tld|¥|10|1966|4=about=yes}} → {{¥|10|1966|about=yes}}
* {{tld|¥|1000|1966|4=round=2}} → {{¥|1000|1966|round=2}}
* {{tld|¥|1000|1966|4=round=-2}} → {{¥|1000|1966|round=-2}}
* {{tld|¥|1000|1966|4=round=-2|5=about=yes}} → {{¥|1000|1966|round=-2|about=yes}}

== Redirects here ==
* [[Template:¥]]
* [[Template:JP¥]]
* [[Template:JP円]]
* [[Template:JP圓]]
* [[Template:Yen]]
* [[Template:円]]

== See also ==
* [[Wikipedia:Manual of Style (dates and numbers)#Currencies]]
* [[Template:Currency]]
* [[Wikipedia:WikiProject Japan]]
* [[Template:AUD]]
* [[Template:CAD]]
* [[Template:CNY]]
* [[Template:US$]]

<includeonly>{{Sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
{{DEFAULTSORT:JPY}} 
[[Category:Japan economy templates]]
[[Category:Currency templates]]
[[Category:Unit indicator templates]]

[[bn:টেমপ্লেট:JPY]]
}}</includeonly>