Template:INRConvert/doc
This is a documentation subpage for Template:INRConvert. It contains usage information, categories and other content that is not part of the original template page. |
This template employs intricate features of template syntax.
You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages. You can conduct experiments, and should test all major changes, in either this template's sandbox, the general template sandbox, or your user space before changing anything here. |
Purpose
The purpose of this template is to automatically convert and format currency from Indian Rupees to other currencies (United States Dollars by default) applying adjustment for inflation where appropriate. Rates of exchange and inflation must be manually copied by editors therefore the template's output does not necessarily reflect the present exchange rates or price indices but, rather, reflects the rates and indices at the time of the last update.
Usage
{{INRConvert|rupee_value|currency_formatting|rounding digits|lk=|to=|year=}}
Parameters
A description of the template's parameters are listed below.
Field name | Usage | Description |
rupee_value |
mandatory | The value, in Indian Rupees, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234). |
currency_formatting |
optional | Used to represent larger numbers. Available options are as follows.
|
rounding_digits |
optional | Used to round significant digits. 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. By default the conversion will be rounded to two significant figures. Refer to the Examples section below for more examples. |
lk |
optional | This parameter gives you the option of internally linking currency names (rupees and paise) and/or number names (lakh and crore). By default, the parameter is set to "off" (i.e. it is set not to link). Available options are as follows.
|
year |
optional | This parameter allows for inflation. Historic rupee values will be inflated to current values then converted. |
to |
optional | This parameter allows for conversion to various different currencies (and some combinations). Currently, the US (default), Canadian, Australian and New Zealand dollars, the euro, the pound sterling, Pakistani rupee and the Bangladeshi taka are supported. |
mode |
optional | This parameter controls the output mode. Setting it to blank or omitting it results in the default mode. Setting it to historical allows conversion using historical exchange rates. The year parameter must be between 1970 and 2018 in historical mode.
|
Examples
INRConvert syntax | Results |
---|---|
{{INRConvert|1}} |
₹1 (1.3¢ US) |
{{INRConvert|500}} |
₹500 (US$6.60) |
{{INRConvert|0.05|lk=on}} |
5 paise (0.066¢ US) |
{{INRConvert|0.01}} |
1 paisa (0.013¢ US) |
{{INRConvert|0.86}} |
86 paise (1.1¢ US) |
{{INRConvert|30|m}} |
₹30 million (US$390,000) |
{{INRConvert|0.72|m}} |
₹0.72 million (US$9,400) |
{{INRConvert|36|b}} |
₹36 billion (US$470 million) |
{{INRConvert|36|b|-2}} |
₹36 billion (US$500 million) |
{{INRConvert|80|b|lk=b}} |
₹80 billion (US$1.0 billion) |
{{INRConvert|32|t|lk=r}} |
₹32 trillion (US$420 billion) |
{{INRConvert|40000|c|lk=on}} |
₹40,000 crore (US$5.2 billion) |
{{INRConvert|40000|c|0}} |
₹40,000 crore (US$5 billion) |
{{INRConvert|19|k}} |
₹19,000 (US$250) |
{{INRConvert|53|m|0}} |
₹53 million (US$695,543) |
{{INRConvert|123|k|year=1990}} |
₹123,000 (equivalent to ₹1.0 million or US$13,000 in 2020) |
{{INRConvert|319|to=GBP}} |
₹319 (£3.20) |
{{INRConvert|753|m|year=2000|to=USD EUR}} |
₹753 million (equivalent to ₹2.6 billion, US$35 million or €31 million in 2020) |
{{INRConvert|324|c|year=2000|to=EUR|mode=historical}} |
₹324 crore (€78.08 million) |
{{INRConvert|240|c|year=2001}} |
₹240 crore (equivalent to ₹812 crore or US$110 million in 2020) |
{{INRConvert|240|c|0|year=2001}} |
₹240 crore (equivalent to ₹812 crore or US$107 million in 2020) |
{{INRConvert|240|c|lk=on|year=2001}} |
₹240 crore (equivalent to ₹812 crore or US$110 million in 2020) |
{{INRConvert|240|c|0|lk=on|year=2001}} |
₹240 crore (equivalent to ₹812 crore or US$107 million in 2020) |
{{INRConvert|240|c|year=2001|0}} |
₹240 crore (equivalent to ₹812 crore or US$107 million in 2020) |
{{INRConvert|240|year=2001|c}} |
₹240 crore (equivalent to ₹812 crore or US$110 million in 2020) |
{{INRConvert|240|year=2001|c|0}} |
₹240 crore (equivalent to ₹812 crore or US$107 million in 2020) |
Precautions
Using the |year=
causes the calling page's Highest expansion depth to be very high, typically at least 33. The limit is 40. Take particular care using |year=
when calling this template from within other templates, as this will further increase the template expansion depth of Wikipedia pages that call templates that call this one.
Updating
It is important to keep the figures used in these conversions up to date. Data for current exchange rates is kept at {{INRConvert/CurrentRate}}. Data for historical exchange rates are kept at {{INRConvert/HistoricalRate}}. Data for the inflation rate is at {{Inflation/IN/dataset}} (see Template:Inflation#Developer documentation for details). Feel free to update these if you are able.
See also
- {{To USD}} leverages {{INRConvert/HistoricalRate}}.
Summary
Template calculates a value of Indian Rupees, which you can enter, to another currency and then presents the results.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Rupee value | 1 | The value, in Indian Rupees, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234).
| Number | required |
Currency formatting | 2 | Use this to represent larger numbers such as crores, billions et al.
| String | suggested |
Linking | lk | Gives the option to whether link currency (Rupees, Paise) and/or number names (crores, lakhs)
| String | suggested |
Year | year | This parameter allows for inflation. Historic rupee values will be inflated to current values then converted.
| Number | suggested |
To | to | This parameter allows for conversion to various different currencies (and some combinations). The US (default), Canadian, NZ and Australian dollars, the euro, the UK pound and the Bangladeshi taka are supported.
| String | optional |
Rounding digits | 3 | Used to round significant digits. 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. By default the conversion will be rounded to two significant figures.
| Number | optional |
Mode | mode | This parameter allows for the control of the output mode. Currently, blank (default) and historical are supported. In historical mode, conversions are performed using a historical exchange rate, for the year supplied. Years between 1970 and 2018 are supported, for XDR, USD (default), GBP, JPY, DEM (until 1998) and EUR (from 1999).
| String | optional |