This is a documentation subpage for Template:CAD. It may contain usage information, categories and other content that is not part of the original template page. |
Relevant discussion at | → Template talk:Currency#Suggestions for a standard set of options for each template |
This is a multifunction template. At its simplest, it adds the currency mark "CA$", as recommended by MOS:CURRENCY for many situations. The template can also link to the Canadian dollar article and can even calculate inflation. See warnings below.
((CAD|number))
Additional text like "million" or "trillion" must be placed outside the template, typically preceded by a non-breaking space (see example below).
Example:
((CAD))
→ CA$((CAD|123.45))
→ CA$123.45((CAD|123))((nbsp))million
→ CA$123 millionThe parameter |link=yes
may be used to link CA$ to the article Canadian dollar. This is turned off by default, but may be appropriate for the first occurrence of the term in an article.
Example:
((CAD|123.45|link=yes))
→ CA$123.45Do not assume that using this template will mean that a calculated value is "current", "as of 2024", "as of 2023" or even necessarily "recent". Do not use ((CURRENTYEAR)) to refer to calculated value, instead ((Inflation/year|CA)) may be used. See also MOS:REALTIME. |
The template supports inflation calculation, by way of ((Inflation))
. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, if 1688 ≤ year
< 2021), the equivalent value represented in 2021 dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.
Examples:
((CAD|100|1687))
→ CA$100((CAD|100|1688))
→ CA$100 (equivalent to $3,541 in 2021)((CAD|100|1966))
→ CA$100 (equivalent to $809.14 in 2021)((CAD|100|1966|link=yes))
→ CA$100 (equivalent to $809.14 in 2021)((CAD|100|2020))
→ CA$100 (equivalent to $103.36 in 2021)((CAD|100|2021))
→ CA$100((CAD|100|2024))
→ CA$100((CAD|100|2025))
→ CA$100Additional parameter |about=yes
will cause the template to calculate to the nearest dollar (instead of the nearest cent), and prefix the calculated value with "about". The rounding can be fine-tuned further by using |round=integer
. These parameters may be combined.
Examples:
((CAD|10|1935))
→ CA$10 (equivalent to $193.97 in 2021)((CAD|10|1935|round=0))
→ CA$10 (equivalent to $194 in 2021)((CAD|10|1935|about=yes))
→ CA$10 (equivalent to about $194 in 2021)((CAD|1000|1935|round=2))
→ CA$1,000 (equivalent to $19,397.26 in 2021)((CAD|1000|1935|round=-2))
→ CA$1,000 (equivalent to $19,400 in 2021)((CAD|1000|1935|round=-2|about=yes))
→ CA$1,000 (equivalent to about $19,400 in 2021)