The purpose of this template is to automatically convert and format Hong Kong dollars. Rates of exchange and inflation must be manually copied by editors in the supporting templates therefore this 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.
The default target currency (USD at present) may change in the future.
A description of the template's parameters are listed below.
Field name
Usage
Example
Description
value
mandatory
10000.01
The value, in Hong Kong dollars, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234).
currency_units
optional
m
Used to represent smaller or larger numbers. Available options are as follows.
ct– to represent cent(s)
p– to represent penny (pence)
pa– to represent paisa (paise) (generalized to mean cents)
po– to represent poysha (generalized to mean cents)
ba– to represent baisa(s) (generalized to mean 1/1000)
k– to represent thousand(s)
m– to represent million(s)
b– to represent short scale billion(s)
t– to represent short scale trillion(s)
l– to represent lakh(s)
c– to represent crore(s)
lc– to represent lakh crore(s)
Brackets in the sense may be singular (or) plural.
The Indian units can be applied to any currency.
lk
optional
lk=on
This parameter gives you the option of internally linking currency names (paise, which is generalized here to mean cents in the source currency) and/or number names (billion, trillion, lakh, crore). By default, the parameter is set to "off" (i.e. it is set not to link). Available options are as follows.
on– to link all units
source– to link the source value
original– to link the values in the original currency
inflated– to link the inflated value in the original currency
result– to link the inflated and converted vales
converted– to link the converted value
source-converted– to link the source and converted values
year
optional
year=2002
This parameter allows entering values from previous years. The year will be displayed and historic values will be converted. The conversion will be attempted for the year indicated (but see force). If year is not provided, just a conversion will be performed at the most current rate available.
to
optional
to=EUR
This parameter allows for conversion to various different currencies. Currently, the USD (default) and the euro are supported.
r
optional
r=3
Sets the digits to which the results must be rounded. A negative value indicates rounding to an upper significant digit, and a positive value indicates a fractional digit including trailing zeros. Defaults to 2.
force
optional
force=yes
This parameter allows to force a conversion at the most current rate available when data is lacking for the provided year when its value is yes.
exact
optional
exact=source
This provides some control over formatting. source requests to display the input value normally (in American fashion) after applying the units. on does this for both the input and result values. Otherwise all values will be displayed as per {{Format price}}.
showdate
optional
showdate=no
This allows to disable displaying the original year.
ref
optional
ref=<ref>some wikitext ref</ref>
This allows displaying one or more references next to the original value. Each one must consist of a ref wikitext element.
mode
optional
mode=historical
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.
convert
optional
convert=no
This parameter controls the currency conversion. Setting it to blank or omitting it results in the default mode. Setting it to no disables it.
Template calculates a value of Hong Kong dollars, which you can enter, converted and then presents the results.
Template parameters
Parameter
Description
Type
Status
Value
1
The value, in the source, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234).
Example
500000000
Number
required
Currency units
2
Use this to represent larger numbers such as crores, billions et al.
Example
c, lc, b, m, k, cr, p, pa, po, ba
Line
suggested
Linking
lk
Gives option to whether link currency names (paise, etc.) or number names (crores, lakhs, billions, trillions)
Example
on, off, source, original, inflated, result, converted, source-converted
Line
suggested
Year
year
This parameter allows for inflation. Historic values will be inflated to the most current values available then converted.
Example
2015
Number
suggested
To
to
This parameter allows for conversion to various different currencies. The USD (default) and the euro are currently supported.
Default
USD
Example
EUR
Unknown
optional
Rounding digits
r
Used to round significant digits. 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
Number
optional
Force
force
This parameter allows to force a conversion at the most current rate available when data is lacking for the provided year when its value is "yes".
Example
yes
Line
optional
Exact
exact
This provides some control over formatting. "source" requests to display the input value normally (in American fashion) after applying the units. "on" does this for both the input and result values. Otherwise all values will be displayed as per Format price.
Example
source, on
Line
optional
Show date
showdate
This allows to disable displaying the original year.
Example
no
Line
optional
References
ref
This allows displaying one or more references next to the original value. Each one must consist of a ref wikitext element.
Example
<ref>some wikitext ref</ref>
Content
suggested
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.
Default
(blank)
Example
historical
Line
optional
Convert
convert
This parameter controls the currency conversion. Setting it to blank or omitting it results in the default mode. Setting it to <code>no</code> disables it.
