Dan9186: 1 revision

2010-08-08T21:10:02Z

1 revision

New page

{{Documentation subpage}}

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>

__NOTOC__

{{Info|Please refer to '''[[Template:INRConvert/bugs|/bugs]]''' for a list of known bugs. Alternatively, a list of resolved problems is detailed '''[[Template:INRConvert/pr|here]]'''.}}

==Purpose==
To automatically convert and format [[foreign currency|currency]] from [[Indian Rupee]]s (Rs.) to [[United States Dollar]]s. (US$) for use on [[India]]-related articles on Wikipedia or wherever appropriate. The actual Rupee-Dollar exchange rate is manually copied each week by a Wikipedia editor from the U.S. Federal Reserve reported data and posted into this template. The conversion is from the value posted by the Wikipedia editor into U.S. dollars. The output does not reflect the present exchange rate; rather, the output reflects the exchage rate posted by the Wikipedia editor at the time the template exchange multiplier is updated.

==Usage==
<code><nowiki>{{INRConvert|rupee_value|currency_formatting|rounding digits|nolink=(yes/no)}}</nowiki></code>

== Parameters ==
A description of the template's parameters are listed below.

{|class="wikitable"
|style="background-color: #A52A2A; font-weight: bolder; color: #FFF5EE;" |Field name ||style="background-color: #A52A2A; font-weight: bolder; color: #FFF5EE;"| Usage ||style="background-color: #A52A2A; font-weight: bolder; color: #FFF5EE;" | Description

|-
|<code>'''rupee_value'''</code> ||mandatory||The value, in [[Indian Rupee]]s, that needs to be converted. The template will not accept pre-formatted values (ie. 1,234)
|-
|<code>'''currency_formatting'''</code>||optional ||Used to represent larger numbers. Available options include :<br />
* <code>k</code> – to represent thousands
* <code>l</code> – to represent [[lakh]]s
* <code>c</code> – to represent [[crore]]s
* <code>m</code> – to represent millions
* <code>b</code> – to represent billions
* <code>t</code> – to represent trillions
|-
|<code>'''rounding_digits'''</code> ||optional ||Used to round [[significant digit]]s. The default value for most numbers with currency formatting is "2" (representing the two digits of [[paise]] and [[cent (currency)|cent]]s. Negative values (-2, -3) can be used to round values to the nearest hundred or thousand, etc. A value of "0" will drop paise or cent values from the converted number. <br />Refer to the [[Template:INRConvert#Examples|Examples section]] below for more examples.
|-
|<code>'''nolink'''</code> ||optional ||This parameter gives you the option of not internally linking currency names (Rupees and US$). By default, the parameter is set to "no" (ie. it is set to link Rupees and US$). Currency names will be displayed with no links when the parameter is set to "yes".
|}

;Foreign Exchange Data Source
:This template will always aim to convert Indian Rupees at current Dollar prices. Source data for INR > USD rates is obtained from the [[United States Federal Reserve]] [http://www.federalreserve.gov/releases/h10/hist/dat00_in.txt online]. Data sourced from the Federal Reserve is [[public domain]].

==Examples==
<span style="align: left;">
{|class="wikitable" style="margin: 1em auto 1em auto; width: 500px; align: left;"
!INRConvert syntax || Results
|-
| <tt><nowiki>{{INRConvert|1}}</nowiki></tt> || {{INRConvert|1}}
|-
| <tt><nowiki>{{INRConvert|500}}</nowiki></tt> || [[Indian Rupee|Rs.]] 500 ([[United States Dollar|US$]] 12.74)
|-
| <tt><nowiki>{{INRConvert|0.05}}</nowiki></tt> || {{INRConvert|0.05}}
|-
| <tt><nowiki>{{INRConvert|0.86}}</nowiki></tt> || {{INRConvert|0.86}}
|-
| <tt><nowiki>{{INRConvert|30|m}}</nowiki></tt> || {{INRConvert|30|m}}
|-
| <tt><nowiki>{{INRConvert|0.72|m}}</nowiki></tt> || {{INRConvert|0.72|m}}
|-
| <tt><nowiki>{{INRConvert|36|b}}</nowiki></tt> || {{INRConvert|36|b}}
|-
| <tt><nowiki>{{INRConvert|36|b|-2}}</nowiki></tt> || {{INRConvert|36|b|-2}}
|-
| <tt><nowiki>{{INRConvert|80|B}}</nowiki></tt> || {{INRConvert|0.80|B}}
|-
| <tt><nowiki>{{INRConvert|32|t}}</nowiki></tt> || {{INRConvert|32|t}}
|-
| <tt><nowiki>{{INRConvert|400|c}}</nowiki></tt> || {{INRConvert|400|c}}
|-
| <tt><nowiki>{{INRConvert|400|c|0}}</nowiki></tt> || {{INRConvert|400|c|0}}
|-
| <tt><nowiki>{{INRConvert|19|k}}</nowiki></tt> || {{INRConvert|19|k}}
|-
| <tt><nowiki>{{INRConvert|53|m|0|nolink=yes}}</nowiki></tt> || {{INRConvert|53|m|2|nolink=yes}}
|}

</span>

<includeonly>
[[Category:Currency conversion templates| ]]
</includeonly>

Template:INRConvert/doc - Revision history

Dan9186: 1 revision