Jump to content

Template:CADConvert/doc

Add links
From Wikipedia, the free encyclopedia


Purpose

[edit]

The purpose of this template is to automatically convert and format Canadian dollars applying adjustment for inflation where appropriate. 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.

The possibility of converting to other target currencies in the future is left open, hence the general name of this template.

Usage

[edit]

{{CADConvert|value|currency_units|year=|to=|r=|force=|lk=|exact=|showdate=|ref=|mode=|convert=}}

Parameters

[edit]

A description of the template's parameters are listed below.

Field name Usage Example Description
value mandatory 10000.01 The value, in the country_code currency, 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 inflated to the latest year available in {{Inflation}} if index is also provided then converted by {{ToUSD}}. If no index name is present, 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.

Examples

[edit]
CADConvert syntax Results
{{CADConvert|1|ct|lk=on}} CA$0.01 (US$0.01)
{{CADConvert|10|ct}} CA$0.1 (US$0.08)
{{CADConvert|1|ct|exact=source}} CA$0.01 (US$0.01)
{{CADConvert|10|ct|exact=source}} CA$0.1 (US$0.08)
{{CADConvert|1|ct|exact=on}} CA$0.01 (US$0.01)
{{CADConvert|10|ct|exact=on}} CA$0.1 (US$0.08)
{{CADConvert|1|ct|year=2002}} CA$0.01 (2002) (equivalent to CA$0.02 or US$0.01 in 2023)[1]
{{CADConvert|10|ct|year=2002}} CA$0.1 (2002) (equivalent to CA$0.16 or US$0.12 in 2023)[1]
{{CADConvert|1|ct|year=2002|mode=historical}} CA$0.01 (2002) (US$0.01)
{{CADConvert|10|ct|year=2002|mode=historical}} CA$0.1 (2002) (US$0.06)
{{CADConvert|1|ct|year=2002|lk=on}} CA$0.01 (2002) (equivalent to CA$0.02 or US$0.01 in 2023)[1]
{{CADConvert|10|ct|year=2002|lk=on}} CA$0.1 (2002) (equivalent to CA$0.16 or US$0.12 in 2023)[1]
{{CADConvert|1|ct|year=2002|exact=on}} CA$0.01 (2002) (equivalent to CA$0.02 or US$0.01 in 2023)[1]
{{CADConvert|10|ct|year=2002|exact=on}} CA$0.1 (2002) (equivalent to CA$0.16 or US$0.12 in 2023)[1]
{{CADConvert|1|ct|lk=on|convert=no}} CA$0.01
{{CADConvert|10|ct|convert=no}} CA$0.1
{{CADConvert|1|ct|exact=source|convert=no}} CA$0.01
{{CADConvert|10|ct|exact=source|convert=no}} CA$0.1
{{CADConvert|1|ct|exact=on|convert=no}} CA$0.01
{{CADConvert|10|ct|exact=on|convert=no}} CA$0.1
{{CADConvert|1|ct|year=2002|convert=no}} CA$0.01 (2002) (equivalent to CA$0.02 in 2023)[1]
{{CADConvert|10|ct|year=2002|convert=no}} CA$0.1 (2002) (equivalent to CA$0.16 in 2023)[1]
{{CADConvert|1|ct|year=2002|mode=historical|convert=no}} CA$0.01 (2002)
{{CADConvert|10|ct|year=2002|mode=historical|convert=no}} CA$0.1 (2002)
{{CADConvert|1|ct|year=2002|lk=on|convert=no}} CA$0.01 (2002) (equivalent to CA$0.02 in 2023)[1]
{{CADConvert|10|ct|year=2002|lk=on|convert=no}} CA$0.1 (2002) (equivalent to CA$0.16 in 2023)[1]
{{CADConvert|1|ct|year=2002|exact=on|convert=no}} CA$0.01 (2002) (equivalent to CA$0.02 in 2023)[1]
{{CADConvert|10|ct|year=2002|exact=on|convert=no}} CA$0.1 (2002) (equivalent to CA$0.16 in 2023)[1]
{{CADConvert|1}} CA$1 (US$0.8)
{{CADConvert|1|k}} CA$1,000 (US$800)
{{CADConvert|1|m}} CA$1 million (US$800,000)
{{CADConvert|1|b|lk=on}} CA$1 billion (US$800 million)
{{CADConvert|1|t|lk=on}} CA$1 trillion (US$800 billion)
{{CADConvert|1|exact=source}} CA$1 (US$0.8)
{{CADConvert|1|k|exact=source}} CA$1,000 (US$800)
{{CADConvert|1|m|exact=source}} CA$1,000,000 (US$800,000)
{{CADConvert|1|b|exact=source}} CA$1,000,000,000 (US$800 million)
{{CADConvert|1|t|exact=source}} CA$1,000,000,000,000 (US$800 billion)
{{CADConvert|1|exact=on}} CA$1 (US$0.8)
{{CADConvert|1|k|exact=on}} CA$1,000 (US$800)
{{CADConvert|1|m|exact=on}} CA$1,000,000 (US$800,000)
{{CADConvert|1|b|exact=on}} CA$1,000,000,000 (US$800,000,000)
{{CADConvert|1|t|exact=on}} CA$1,000,000,000,000 (US$800,000,000,000)
{{CADConvert|1|year=2002}} CA$1 (2002) (equivalent to CA$1.57 or US$1.16 in 2023)[1]
{{CADConvert|1|k|year=2002}} CA$1,000 (2002) (equivalent to CA$1,571 or US$1,163.78 in 2023)[1]
{{CADConvert|1|m|year=2002}} CA$1 million (2002) (equivalent to CA$1.57 million or US$1.16 million in 2023)[1]
{{CADConvert|1|b|year=2002}} CA$1 billion (2002) (equivalent to CA$1.57 billion or US$1.16 billion in 2023)[1]
{{CADConvert|1|t|year=2002}} CA$1 trillion (2002) (equivalent to CA$1.57 trillion or US$1.16 trillion in 2023)[1]
{{CADConvert|1|year=2002|lk=on}} CA$1 (2002) (equivalent to CA$1.57 or US$1.16 in 2023)[1]
{{CADConvert|1|k|year=2002|lk=on}} CA$1,000 (2002) (equivalent to CA$1,571 or US$1,163.78 in 2023)[1]
{{CADConvert|1|m|year=2002|lk=on}} CA$1 million (2002) (equivalent to CA$1.57 million or US$1.16 million in 2023)[1]
{{CADConvert|1|b|year=2002|lk=on}} CA$1 billion (2002) (equivalent to CA$1.57 billion or US$1.16 billion in 2023)[1]
{{CADConvert|1|t|year=2002|lk=on}} CA$1 trillion (2002) (equivalent to CA$1.57 trillion or US$1.16 trillion in 2023)[1]
{{CADConvert|3.60}} CA$3.6 (US$2.88)
{{CADConvert|360}} CA$360 (US$288)
{{CADConvert|3600}} CA$3,600 (US$2,880)
{{CADConvert|360000}} CA$360,000 (US$288,000)
{{CADConvert|3600000}} CA$3.6 million (US$2.88 million)
{{CADConvert|3.6|m}} CA$3.6 million (US$2.88 million)
{{CADConvert|3650000}} CA$3.65 million (US$2.92 million)
{{CADConvert|3.65|m}} CA$3.65 million (US$2.92 million)
{{CADConvert|3650000|year=1914}} CA$3.65 million (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3.65|m|year=1914}} CA$3.65 million (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3650000|year=1914|exact=source}} CA$3,650,000 (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3.65|m|year=1914|exact=source}} CA$3,650,000 (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3650000|year=1914|force=yes}} CA$3.65 million (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3.65|m|year=1914|force=yes}} CA$3.65 million (1914) (equivalent to CA$95.57 million or US$70.8 million in 2023)[1]
{{CADConvert|3650000|year=1914|force=yes|exact=on}} CA$3,650,000 (1914) (equivalent to CA$95,569,166.67 or US$70,796,766.38 in 2023)[1]
{{CADConvert|3.65|m|year=1914|force=yes|exact=on}} CA$3,650,000 (1914) (equivalent to CA$95,569,166.67 or US$70,796,766.38 in 2023)[1]
{{CADConvert|3650000|year=2002}} CA$3.65 million (2002) (equivalent to CA$5.73 million or US$4.25 million in 2023)[1]
{{CADConvert|3.65|m|year=2002}} CA$3.65 million (2002) (equivalent to CA$5.73 million or US$4.25 million in 2023)[1]
{{CADConvert|3650000|year=2002|exact=on}} CA$3,650,000 (2002) (equivalent to CA$5,734,150 or US$4,247,805.98 in 2023)[1]
{{CADConvert|3.65|m|year=2002|exact=on}} CA$3,650,000 (2002) (equivalent to CA$5,734,150 or US$4,247,805.98 in 2023)[1]
{{CADConvert|3650000|year=2002|exact=source}} CA$3,650,000 (2002) (equivalent to CA$5.73 million or US$4.25 million in 2023)[1]
{{CADConvert|3.65|m|year=2002|exact=source}} CA$3,650,000 (2002) (equivalent to CA$5.73 million or US$4.25 million in 2023)[1]
{{CADConvert|3650000|year=2002|exact=on}} CA$3,650,000 (2002) (equivalent to CA$5,734,150 or US$4,247,805.98 in 2023)[1]
{{CADConvert|3.65|m|year=2002|exact=on}} CA$3,650,000 (2002) (equivalent to CA$5,734,150 or US$4,247,805.98 in 2023)[1]
{{CADConvert|3600000|year=1962|ref=<ref name="qv">http://www.westcoastferries.ca/ferries/bcferries/queenofvancouver.html</ref>}} CA$3.6 million (1962)[2] (equivalent to CA$35.57 million or US$26.35 million in 2023)[1]
{{CADConvert|3600000|year=1962|ref=<ref name="qv">http://www.westcoastferries.ca/ferries/bcferries/queenofvancouver.html</ref><ref>something</ref>}} CA$3.6 million (1962)[2][3] (equivalent to CA$35.57 million or US$26.35 million in 2023)[1]
{{CADConvert|3600000|year=2011|to=EUR|ref=<ref name="S1">something1</ref>}} CA$3.6 million (2011)[4] (equivalent to CA$4.72 million or €FXConvert/Wordify error: cannot parse value "Undefined year "2023"" in 2023)[1]
{{CADConvert|3600000|year=2011|to=EUR|showdate=no|ref=<ref name="S1">something1</ref>}} CA$3.6 million[4] (equivalent to CA$4.72 million or €FXConvert/Wordify error: cannot parse value "Undefined year "2023"" in 2023)[1]
  1. ^ a b c d e f g h i j k l m n o p q r s t u v w x y z aa ab ac ad ae af ag ah ai aj ak al am an ao ap 1688 to 1923: Geloso, Vincent, A Price Index for Canada, 1688 to 1850 (December 6, 2016). Afterwards, Canadian inflation numbers based on Statistics Canada tables 18-10-0005-01 (formerly CANSIM 326-0021) "Consumer Price Index, annual average, not seasonally adjusted". Statistics Canada. Retrieved April 17, 2021. and table 18-10-0004-13 "Consumer Price Index by product group, monthly, percentage change, not seasonally adjusted, Canada, provinces, Whitehorse, Yellowknife and Iqaluit". Statistics Canada. Retrieved 2024-05-08.
  2. ^ a b http://www.westcoastferries.ca/ferries/bcferries/queenofvancouver.html
  3. ^ something
  4. ^ a b something1

See also

[edit]
  • {{FXConvert}}: Inflates and converts a given currency to US dollars or Euro. It is used by {{CADConvert}}.

TemplateData

[edit]
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:CADConvert in articles based on its TemplateData.

TemplateData for CADConvert

Template calculates a value of Canadian dollars, which you can enter, to US dollars and then presents the results.

Template parameters

ParameterDescriptionTypeStatus
Value1

The value, in the source, that needs to be converted. The template will not accept pre-formatted values (i.e. 1,234).

Example
500000000
Numberrequired
Currency units2

Use this to represent larger numbers such as crores, billions et al.

Example
c, lc, b, m, k, cr, p, pa, po, ba
Linesuggested
Linkinglk

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
Linesuggested
Yearyear

This parameter allows for inflation. Historic values will be inflated to the most current values available then converted.

Example
2015
Numbersuggested
Toto

This parameter allows for conversion to various different currencies. The USD (default) and the euro are currently supported.

Default
USD
Example
EUR
Unknownoptional
Rounding digitsr

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
Numberoptional
Forceforce

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
Lineoptional
Exactexact

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
Lineoptional
Show dateshowdate

This allows to disable displaying the original year.

Example
no
Lineoptional
Referencesref

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>
Contentsuggested
Modemode

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
Lineoptional
Convertconvert

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.

Default
(blank)
Example
no
Lineoptional


Retrieved from "https://wiki.riteme.site/w/index.php?title=Template:CADConvert/doc&oldid=1003205074"