Difference between revisions of "Template:CAD/doc"
imported>Jdaloner m (Update name of this template.) |
imported>Bsherr m (replacing Template:Tld with Template:Tlc, plus general and typo fixes as found) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
| − | <!-- | + | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> |
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. <em>See warnings below.</em> | 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. <em>See warnings below.</em> | ||
| Line 8: | Line 8: | ||
Example: | Example: | ||
| − | * {{ | + | * {{tlc|CAD}} → {{CAD}} |
| − | * {{ | + | * {{tlc|CAD|123.45}} → {{CAD|123.45}} |
=== Link === | === Link === | ||
| Line 15: | Line 15: | ||
Example: | Example: | ||
| − | * {{ | + | * {{tlc|CAD|123.45|3=link=yes}} → {{CAD|123.45|link=yes}} |
=== Inflation calculation === | === Inflation calculation === | ||
| Line 27: | Line 27: | ||
Examples: | Examples: | ||
| − | * {{ | + | * {{tlc|CAD|100|{{#expr:{{Inflation/CA/startyear}}-1}}}} → {{CAD|100|{{#expr:{{Inflation/CA/startyear}}-1}}}} |
| − | * {{ | + | * {{tlc|CAD|100|{{Inflation/CA/startyear}}}} → {{CAD|100|{{Inflation/CA/startyear}}}} |
| − | * {{ | + | * {{tlc|CAD|100|1966}} → {{CAD|100|1966}} |
| − | * {{ | + | * {{tlc|CAD|100|1966|4=link=yes}} → {{CAD|100|1966|link=yes}} |
| − | * {{ | + | * {{tlc|CAD|100|{{#expr:{{Inflation/year|CA}}-1}}}} → {{CAD|100|{{#expr:{{Inflation/year|CA}}-1}}}} |
| − | * {{ | + | * {{tlc|CAD|100|{{Inflation/year|CA}}}} → {{CAD|100|{{Inflation/year|CA}}}} |
| − | * {{ | + | * {{tlc|CAD|100|{{CURRENTYEAR}}}} → {{CAD|100|{{CURRENTYEAR}}}} |
| − | * {{ | + | * {{tlc|CAD|100|{{#expr:{{CURRENTYEAR}}+1}}}} → {{CAD|100|{{#expr:{{CURRENTYEAR}}+1}}}} |
Additional parameter {{para|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 {{para|round|{{var|integer}}}}. These parameters may be combined. | Additional parameter {{para|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 {{para|round|{{var|integer}}}}. These parameters may be combined. | ||
Examples: | Examples: | ||
| − | * {{ | + | * {{tlc|CAD|10|1935}} → {{CAD|10|1935}} |
| − | * {{ | + | * {{tlc|CAD|10|1935|4=round=0}} → {{CAD|10|1935|round=0}} |
| − | * {{ | + | * {{tlc|CAD|10|1935|4=about=yes}} → {{CAD|10|1935|about=yes}} |
| − | * {{ | + | * {{tlc|CAD|1000|1935|4=round=2}} → {{CAD|1000|1935|round=2}} |
| − | * {{ | + | * {{tlc|CAD|1000|1935|4=round=-2}} → {{CAD|1000|1935|round=-2}} |
| − | * {{ | + | * {{tlc|CAD|1000|1935|4=round=-2|5=about=yes}} → {{CAD|1000|1935|round=-2|about=yes}} |
== Redirects here == | == Redirects here == | ||
| Line 56: | Line 56: | ||
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
| − | <!-- | + | <!-- Categories below this line; interwikis at Wikidata --> |
[[Category:Canada templates]] | [[Category:Canada templates]] | ||
[[Category:Currency templates]] | [[Category:Currency templates]] | ||
Revision as of 17:08, 9 August 2020
| This is a documentation subpage for Template:CAD. It contains usage information, categories and other content that is not part of the original template page. |
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.
Usage
{{CAD|value}}
Example:
{{CAD}}→ CA${{CAD|123.45}}→ CA$123.45
Link
The 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.45
Inflation calculation
Do not assume that using this template will mean that a calculated value is "current", "as of 2025", "as of 2024" 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 1914 ≤ year < 2018), the equivalent value represented in 2018 dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.
Examples:
{{CAD|100|1913}}→ CA$100{{CAD|100|1914}}→ CA$100 (equivalent to $2,223 in 2018){{CAD|100|1966}}→ CA$100 (equivalent to $762.29 in 2018){{CAD|100|1966|link=yes}}→ CA$100 (equivalent to $762.29 in 2018){{CAD|100|2017}}→ CA$100 (equivalent to $102.3 in 2018){{CAD|100|2018}}→ CA$100{{CAD|100|2025}}→ CA$100{{CAD|100|2026}}→ CA$100
Additional 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 $182.74 in 2018){{CAD|10|1935|round=0}}→ CA$10 (equivalent to $183 in 2018){{CAD|10|1935|about=yes}}→ CA$10 (equivalent to about $183 in 2018){{CAD|1000|1935|round=2}}→ CA$1,000 (equivalent to $18,273.97 in 2018){{CAD|1000|1935|round=-2}}→ CA$1,000 (equivalent to $18,300 in 2018){{CAD|1000|1935|round=-2|about=yes}}→ CA$1,000 (equivalent to about $18,300 in 2018)
Redirects here
See also
- Wikipedia:Manual of Style (dates and numbers)#Currencies
- Wikipedia:Canadian Wikipedians' notice board/Style guide#Currency
- Template:AUD
- Template:US$