Template:INRConvert/doc: Difference between revisions

Latest revision as of 13:42, 31 May 2014

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.

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|nolink=(yes/no)|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 include : `k` – to represent thousand(s) `l` – to represent lakh(s) `c` – to represent crore(s) `m` – to represent million(s) `b` – to represent billion(s) `t` – to represent trillion(s) Brackets in the sense may be singular (or) plural.
`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.
`nolink`	optional	This parameter gives you the option of not internally linking currency names (Rupees and paise) and number names (lakh and crore). By default, the parameter is set to "no" (i.e. it is set to link). Currency and number names will be displayed with no links when the parameter is set to "yes". Per SV:OVERLINK the currencies converted to are not linked.
`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). The US, Canadian, NZ and Australian dollars, the euro, the UK pound and the Bangladeshi taka are supported.

Examples

INRConvert syntax	Results
`{{INRConvert\|1}}`	₹1 (1.7¢ US)
`{{INRConvert\|500}}`	₹500 (US$8.50)
`{{INRConvert\|0.05}}`	5 paise (0.085¢ US)
`{{INRConvert\|0.01}}`	1 paisa (0.017¢ US)
`{{INRConvert\|0.86}}`	86 paise (1.5¢ US)
`{{INRConvert\|30\|m}}`	₹30 million (US$510,000)
`{{INRConvert\|0.72\|m}}`	₹0.72 million (US$12,000)
`{{INRConvert\|36\|b}}`	₹36 billion (US$610 million)
`{{INRConvert\|36\|b\|-2}}`	₹36 billion (US$600 million)
`{{INRConvert\|80\|B}}`	₹0.80 billion (US$14 million)
`{{INRConvert\|32\|t}}`	₹32 trillion (US$540 billion)
`{{INRConvert\|400\|c}}`	₹400 crore (US$68 million)
`{{INRConvert\|400\|c\|0}}`	₹400 crore (US$68 million)
`{{INRConvert\|19\|k}}`	₹19,000 (US$320)
`{{INRConvert\|53\|m\|0\|nolink=yes}}`	₹53 million (US$901,000)
`{{INRConvert\|123\|k\|year=1990}}`	₹123,000 (equivalent to ₹620,000 or US$11,000 in 2024)
`{{INRConvert\|319\|to=GBP}}`	₹319 (£3.20)
`{{INRConvert\|753\|m\|year=2000\|to=USD EUR}}`	₹753 million (equivalent to ₹1.8 billion, US$30 million or €22 million in 2024)

Updating

It is important to keep the figures used in these conversions up to date. Data for the exchange rates is kept at {{INRConvert/CurrentRate}}. Data for the inflation rate is at {{Inflation/IN/dataset}}. Feel free to up date these if you are able.

@@ Line 17: / Line 17: @@
 |-
-|<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>'''rupee_value'''</code> ||mandatory||The value, in [[Indian Rupee]]s, that needs to be converted.  The template will not accept pre-formatted values (i.e. 1,234)
 |-
-|<code>'''currency_formatting'''</code>||optional ||Used to represent larger numbers.  Available options include :<br />
+|<code>'''currency_formatting'''</code>||optional ||Used to represent larger numbers.  Available options include :
 * <code>k</code> &ndash; to represent thousand(s)
 * <code>l</code> &ndash; to represent lakh(s)
@@ Line 32: / Line 32: @@
 |<code>'''rounding_digits'''</code> ||optional ||Used to round [[significant digit]]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.  By default the conversion will be rounded to two significant figures.<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 paise) and number names (lakh and crore).  By default, the parameter is set to "no" (ie. it is set to link).  Currency and number names will be displayed with no links when the parameter is set to "yes".   Per [[WP:OVERLINK]] the currencies converted to are not linked.
+|<code>'''nolink'''</code> ||optional ||This parameter gives you the option of not internally linking currency names (Rupees and paise) and number names (lakh and crore).  By default, the parameter is set to "no" (i.e. it is set to link).  Currency and number names will be displayed with no links when the parameter is set to "yes".   Per [[SV:OVERLINK]] the currencies converted to are not linked.
 |-
 |<code>'''year'''</code> ||optional ||This parameter allows for inflation.  Historic rupee values will be inflated to current values then converted.