View source for Template:PKRConvert/doc

{{Documentation subpage}}
<!-- 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 [[Pakistani 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>{{PKRConvert|rupee_value|currency_formatting|rounding  digits|nolink=(yes/no)|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 [[Pakistani rupee]]s, that needs to be converted.  The template will not accept pre-formatted values (e.g. 1,234)
|-
|<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)
* <code>c</code> &ndash; to represent crore(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)

* '''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:PKRConvert#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" (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 [[WP: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.  
|-
|<code>'''to'''</code> ||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==

{|class="wikitable"
!PKRConvert syntax || Results
|-
| <code><nowiki>{{PKRConvert|1}}</nowiki></code> || {{PKRConvert|1}} 
|-
| <code><nowiki>{{PKRConvert|500}}</nowiki></code> || {{PKRConvert|500}} 
|-
| <code><nowiki>{{PKRConvert|0.05}}</nowiki></code> || {{PKRConvert|0.05}}
|-
| <code><nowiki>{{PKRConvert|0.01}}</nowiki></code> || {{PKRConvert|0.01}}
|-
| <code><nowiki>{{PKRConvert|0.86}}</nowiki></code> || {{PKRConvert|0.86}}
|-
| <code><nowiki>{{PKRConvert|30|m}}</nowiki></code> || {{PKRConvert|30|m}}
|-
| <code><nowiki>{{PKRConvert|0.72|m}}</nowiki></code> || {{PKRConvert|0.72|m}}
|-
| <code><nowiki>{{PKRConvert|36|b}}</nowiki></code> || {{PKRConvert|36|b}}
|-
| <code><nowiki>{{PKRConvert|36|b|-2}}</nowiki></code> || {{PKRConvert|36|b|-2}}
|-
| <code><nowiki>{{PKRConvert|0.80|B}}</nowiki></code> || {{PKRConvert|0.80|B}}
|-
| <code><nowiki>{{PKRConvert|32|t}}</nowiki></code> || {{PKRConvert|32|t}}
|-
| <code><nowiki>{{PKRConvert|400|c}}</nowiki></code> || {{PKRConvert|400|c}}
|-
| <code><nowiki>{{PKRConvert|400|c|0}}</nowiki></code> || {{PKRConvert|400|c|0}}
|-
| <code><nowiki>{{PKRConvert|19|k}}</nowiki></code> ||  {{PKRConvert|19|k}}
|-
| <code><nowiki>{{PKRConvert|53|m|0|nolink=yes}}</nowiki></code> || {{PKRConvert|53|m|0|nolink=yes}} 
|-
| <code><nowiki>{{PKRConvert|123|k|year=1990}}</nowiki></code> || {{PKRConvert|123|k|year=1990}}
|-
| <code><nowiki>{{PKRConvert|319|to=GBP}}</nowiki></code> ||  {{PKRConvert|319|to=GBP}}
|-
| <code><nowiki>{{PKRConvert|753|m|year=2000|to=USD EUR}}</nowiki></code> || {{PKRConvert|753|m|year=2000|to=USD EUR}} 
|}

==Updating==
It is important to keep the figures used in these conversions up to date.  Data for the exchange rates is kept at {{tl|PKRConvert/CurrentRate}}. Data for the inflation rate is at {{tl|Inflation/PK/dataset}}. Feel free to update these if you are able.

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