View source for Template:INRConvert/doc

{{Documentation subpage}}
{{intricate template}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
__NOTOC__

==Purpose==
The purpose of this template is to automatically convert and format [[foreign currency|currency]] from [[Indian Rupee]]s to other currencies ([[United States Dollar]]s by default) applying adjustment for inflation where appropriate. Rates of exchange and inflation must be [[#Updating|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==
<code><nowiki>{{INRConvert|rupee_value|currency_formatting|rounding  digits|lk=|to=|year=}}</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 (i.e. 1,234).
|-
|<code>'''currency_formatting'''</code>||optional ||Used to represent larger numbers. Available options are as follows.
* <code>k</code> &ndash; to represent thousand(s)
* <code>m</code> &ndash; to represent million(s)
* <code>b</code> &ndash; to represent billion(s)
* <code>t</code> &ndash; to represent trillion(s)
* <code>l</code> &ndash; to represent lakh(s)
* <code>c</code> &ndash; to represent crore(s)
* <code>lc</code> &ndash; to represent lakh crore(s)

* '''Brackets in the sense may be singular (or) plural'''.

|-
|<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>'''lk'''</code> ||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.
* <code>on</code> &ndash; to link "rupee"/"paise" and "lakh"/"crore"/"billion"
* <code>r</code> &ndash; to link "rupee"/"paise"
* <code>b</code> &ndash; to link "billion"
* <code>t</code> &ndash; to link "trillion"
* <code>l</code> &ndash; to link "lakh"
* <code>c</code> &ndash; to link "crore"
* <code>lc</code> &ndash; to link "lakh" and "crore"
|-
|<code>'''year'''</code> ||optional ||This parameter allows for inflation.  Historic rupee values will be inflated to current values then converted.  
|-
|<code>'''to'''</code> ||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.
|-
|<code>'''mode'''</code> ||optional ||This parameter controls the output mode. Setting it to blank or omitting it results in the default mode. Setting it to <code>historical</code> allows conversion using historical exchange rates. The <code>year</code> parameter must be between 1970 and 2018 in historical mode.
|}

==Examples==

{|class="wikitable"
!INRConvert syntax || Results
|-
| <code><nowiki>{{INRConvert|1}}</nowiki></code> || {{INRConvert|1}} 
|-
| <code><nowiki>{{INRConvert|500}}</nowiki></code> || {{INRConvert|500}} 
|-
| <code><nowiki>{{INRConvert|0.05|lk=on}}</nowiki></code> || {{INRConvert|0.05|lk=on}}
|-
| <code><nowiki>{{INRConvert|0.01}}</nowiki></code> || {{INRConvert|0.01}}
|-
| <code><nowiki>{{INRConvert|0.86}}</nowiki></code> || {{INRConvert|0.86}}
|-
| <code><nowiki>{{INRConvert|30|m}}</nowiki></code> || {{INRConvert|30|m}}
|-
| <code><nowiki>{{INRConvert|0.72|m}}</nowiki></code> || {{INRConvert|0.72|m}}
|-
| <code><nowiki>{{INRConvert|36|b}}</nowiki></code> || {{INRConvert|36|b}}
|-
| <code><nowiki>{{INRConvert|36|b|-2}}</nowiki></code> || {{INRConvert|36|b|-2}}
|-
| <code><nowiki>{{INRConvert|80|b|lk=b}}</nowiki></code> || {{INRConvert|80|b|lk=b}}
|-
| <code><nowiki>{{INRConvert|32|t|lk=r}}</nowiki></code> || {{INRConvert|32|t|lk=r}}
|-
| <code><nowiki>{{INRConvert|40000|c|lk=on}}</nowiki></code> || {{INRConvert|40000|c|lk=on}}
|-
| <code><nowiki>{{INRConvert|40000|c|0}}</nowiki></code> || {{INRConvert|40000|c|0}}
|-
| <code><nowiki>{{INRConvert|19|k}}</nowiki></code> ||  {{INRConvert|19|k}}
|-
| <code><nowiki>{{INRConvert|53|m|0}}</nowiki></code> || {{INRConvert|53|m|0}} 
|-
| <code><nowiki>{{INRConvert|123|k|year=1990}}</nowiki></code> || {{INRConvert|123|k|year=1990}}
|-
| <code><nowiki>{{INRConvert|319|to=GBP}}</nowiki></code> ||  {{INRConvert|319|to=GBP}}
|-
| <code><nowiki>{{INRConvert|753|m|year=2000|to=USD EUR}}</nowiki></code> || {{INRConvert|753|m|year=2000|to=USD EUR}}
|-
| <code><nowiki>{{INRConvert|324|c|year=2000|to=EUR|mode=historical}}</nowiki></code> || {{INRConvert|324|c|year=2000|to=EUR|mode=historical}}
|-
| <code><nowiki>{{INRConvert|240|c|year=2001}}</nowiki></code> || {{INRConvert|240|c|year=2001}}
|-
| <code><nowiki>{{INRConvert|240|c|0|year=2001}}</nowiki></code> || {{INRConvert|240|c|0|year=2001}}
|-
| <code><nowiki>{{INRConvert|240|c|lk=on|year=2001}}</nowiki></code> || {{INRConvert|240|c|lk=on|year=2001}}
|-
| <code><nowiki>{{INRConvert|240|c|0|lk=on|year=2001}}</nowiki></code> || {{INRConvert|240|c|0|lk=on|year=2001}}
|-
| <code><nowiki>{{INRConvert|240|c|year=2001|0}}</nowiki></code> || {{INRConvert|240|c|year=2001|0}}
|-
| <code><nowiki>{{INRConvert|240|year=2001|c}}</nowiki></code> || {{INRConvert|240|year=2001|c}}
|-
| <code><nowiki>{{INRConvert|240|year=2001|c|0}}</nowiki></code> || {{INRConvert|240|year=2001|c|0}}
|}

==Precautions==
Using the {{para|year}} causes the calling page's [[Wikipedia:Template limits#Highest expansion depth|Highest expansion depth]] to be very high, typically at least 33. The limit is 40. Take particular care using {{para|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 {{tl|INRConvert/CurrentRate}}. Data for historical exchange rates are kept at {{tl|INRConvert/HistoricalRate}}. Data for the inflation rate is at {{tl|Inflation/IN/dataset}} (see ''[[Template:Inflation#Developer documentation]]'' for details). Feel free to update these if you are able.

== See also ==
*{{tl|To USD}} leverages {{tl|INRConvert/HistoricalRate}}.

==Summary==
<templatedata>
{
	"params": {
		"1": {
			"label": "Rupee value",
			"description": "The value, in Indian Rupees, that needs to be converted.  The template will not accept pre-formatted values (i.e. 1,234).",
			"example": "500000000",
			"required": true,
			"type": "number"
		},
		"2": {
			"label": "Currency formatting",
			"description": "Use this to represent larger numbers such as crores, billions et al.",
			"example": "c, lc, b, m, k",
			"suggested": true,
			"type": "string",
			"suggestedvalues": [
				"b",
				"c",
				"k",
				"l",
				"lc",
				"m",
				"t"
			]
		},
		"3": {
			"label": "Rounding digits",
			"description": "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.",
			"example": "0",
			"type": "number",
			"default": "2"
		},
		"lk": {
			"label": "Linking",
			"description": "Gives the option to whether link currency (Rupees, Paise) and/or number names (crores, lakhs)",
			"suggested": true,
			"example": "on, off, l, c, lc, b, t (Default: off)",
			"type": "string",
			"suggestedvalues": [
				"on",
				"off",
				"l",
				"c",
				"lc",
				"b",
				"t"
			]
		},
		"year": {
			"description": "This parameter allows for inflation. Historic rupee values will be inflated to current values then converted.",
			"example": "2015",
			"label": "Year",
			"suggested": true,
			"type": "number"
		},
		"to": {
			"description": "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.",
			"example": "USD, EUR",
			"default": "USD",
			"label": "To",
			"type": "string"
		},
		"mode": {
			"description": "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).",
			"example": "historical",
			"default": "(blank)",
			"label": "Mode",
			"type": "string"
		}
	},
	"paramOrder": [
		"1",
		"2",
		"lk",
		"year",
		"to",
		"3",
		"mode"
	],
	"description": "Template calculates a value of Indian Rupees, which you can enter, to another currency and then presents the results.",
	"format": "inline"
}
</templatedata>

<includeonly>{{Sandbox other||<!--
++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
[[Category:Currency conversion templates| ]]
[[bn:টেমপ্লেট:INRConvert]]
[[pt:Predefinição:INRConvert]]
}}</includeonly> 

<!-- DO NOT EDIT BEYOND THIS LINE. -->