Difference between revisions of "Template:AUD/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Jdaloner
m ("{{Inflation-year" --> "{{Inflation/year")
blackwiki>Jdaloner
m (Updated name of this template ("A$" --> "AUD").)
Line 5: Line 5:
  
 
== Usage ==
 
== Usage ==
{{tlxi|A$|value}}
+
{{tlxi|AUD|value}}
  
 
Example:
 
Example:
* {{tld|A$}} → {{A$}}
+
* {{tld|AUD}} → {{AUD}}
* {{tld|A$|123.45}} → {{A$|123.45}}
+
* {{tld|AUD|123.45}} → {{AUD|123.45}}
  
 
=== Link ===
 
=== Link ===
Line 15: Line 15:
  
 
Example:
 
Example:
* {{tld|A$|123.45|3=link=yes}} → {{A$|123.45|link=yes}}
+
* {{tld|AUD|123.45|3=link=yes}} → {{AUD|123.45|link=yes}}
  
 
=== Inflation calculation ===
 
=== Inflation calculation ===
Line 23: Line 23:
 
The template supports inflation calculation, by way of {{tlx|Inflation}}. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, {{nowrap|if {{Inflation/AU/startyear}} ≤ <code>{{var|year}}</code> < {{Inflation/year|AU}}}}), the equivalent value represented in {{Inflation/year|AU}} dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.
 
The template supports inflation calculation, by way of {{tlx|Inflation}}. If the second parameter is used, to specify a year, and this year is within a certain range of available inflation data (specifically, {{nowrap|if {{Inflation/AU/startyear}} ≤ <code>{{var|year}}</code> < {{Inflation/year|AU}}}}), the equivalent value represented in {{Inflation/year|AU}} dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.
  
* {{tlxi|A$|value|year}}
+
* {{tlxi|AUD|value|year}}
* {{tlx|A$|{{var|value}}|{{var|year}}|4=round={{var|round}}|5=about=yes}}
+
* {{tlx|AUD|{{var|value}}|{{var|year}}|4=round={{var|round}}|5=about=yes}}
  
 
Examples:
 
Examples:
* {{tld|A$|100|{{#expr:{{Inflation/AU/startyear}}-1}}}} → {{A$|100|{{#expr:{{Inflation/AU/startyear}}-1}}}}
+
* {{tld|AUD|100|{{#expr:{{Inflation/AU/startyear}}-1}}}} → {{AUD|100|{{#expr:{{Inflation/AU/startyear}}-1}}}}
* {{tld|A$|100|{{Inflation/AU/startyear}}}} → {{A$|100|{{Inflation/AU/startyear}}}}
+
* {{tld|AUD|100|{{Inflation/AU/startyear}}}} → {{AUD|100|{{Inflation/AU/startyear}}}}
* {{tld|A$|100|1966}} → {{A$|100|1966}}
+
* {{tld|AUD|100|1966}} → {{AUD|100|1966}}
* {{tld|A$|100|1966|4=link=yes}} → {{A$|100|1966|link=yes}}
+
* {{tld|AUD|100|1966|4=link=yes}} → {{AUD|100|1966|link=yes}}
* {{tld|A$|100|{{#expr:{{Inflation/year|AU}}-1}}}} → {{A$|100|{{#expr:{{Inflation/year|AU}}-1}}}}
+
* {{tld|AUD|100|{{#expr:{{Inflation/year|AU}}-1}}}} → {{AUD|100|{{#expr:{{Inflation/year|AU}}-1}}}}
* {{tld|A$|100|{{Inflation/year|AU}}}} → {{A$|100|{{Inflation/year|AU}}}}
+
* {{tld|AUD|100|{{Inflation/year|AU}}}} → {{AUD|100|{{Inflation/year|AU}}}}
* {{tld|A$|100|{{CURRENTYEAR}}}} → {{A$|100|{{CURRENTYEAR}}}}
+
* {{tld|AUD|100|{{CURRENTYEAR}}}} → {{AUD|100|{{CURRENTYEAR}}}}
* {{tld|A$|100|{{#expr:{{CURRENTYEAR}}+1}}}} → {{A$|100|{{#expr:{{CURRENTYEAR}}+1}}}}
+
* {{tld|AUD|100|{{#expr:{{CURRENTYEAR}}+1}}}} → {{AUD|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:
* {{tld|A$|10|1935}} → {{A$|10|1935}}
+
* {{tld|AUD|10|1935}} → {{AUD|10|1935}}
* {{tld|A$|10|1935|4=round=0}} → {{A$|10|1935|round=0}}
+
* {{tld|AUD|10|1935|4=round=0}} → {{AUD|10|1935|round=0}}
* {{tld|A$|10|1935|4=about=yes}} → {{A$|10|1935|about=yes}}
+
* {{tld|AUD|10|1935|4=about=yes}} → {{AUD|10|1935|about=yes}}
* {{tld|A$|1000|1935|4=round=2}} → {{A$|1000|1935|round=2}}
+
* {{tld|AUD|1000|1935|4=round=2}} → {{AUD|1000|1935|round=2}}
* {{tld|A$|1000|1935|4=round=-2}} → {{A$|1000|1935|round=-2}}
+
* {{tld|AUD|1000|1935|4=round=-2}} → {{AUD|1000|1935|round=-2}}
* {{tld|A$|1000|1935|4=round=-2|5=about=yes}} → {{A$|1000|1935|round=-2|about=yes}}
+
* {{tld|AUD|1000|1935|4=round=-2|5=about=yes}} → {{AUD|1000|1935|round=-2|about=yes}}
  
 
== Redirects here ==
 
== Redirects here ==

Revision as of 04:44, 18 October 2018

This is a multifunction template. At its simplest, it adds the currency mark "A$", as recommended by MOS:CURRENCY for many situations. The template can also link to the Australian dollar article and can even calculate inflation. See warnings below.

Usage

{{AUD|value}}

Example:

  • {{AUD}}A$
  • {{AUD|123.45}}A$123.45

Link

The parameter |link=yes may be used to link A$ to the article Australian dollar. This is turned off by default, but may be appropriate for the first occurrence of the term in an article.

Example:

  • {{AUD|123.45|link=yes}}A$123.45

Inflation calculation

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 1901 ≤ year < 2018), the equivalent value represented in 2018 dollars will be calculated in parentheses. However, this function should only be used in appropriate situations.

  • {{AUD|value|year}}
  • {{AUD|value|year|round=round|about=yes}}

Examples:

  • {{AUD|100|1900}}A$100
  • {{AUD|100|1901}}A$100 (equivalent to $7,723 in 2018)
  • {{AUD|100|1966}}A$100 (equivalent to $1,315 in 2018)
  • {{AUD|100|1966|link=yes}}A$100 (equivalent to $1,315 in 2018)
  • {{AUD|100|2017}}A$100 (equivalent to $101.91 in 2018)
  • {{AUD|100|2018}}A$100
  • {{AUD|100|2025}}A$100
  • {{AUD|100|2026}}A$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:

  • {{AUD|10|1935}}A$10 (equivalent to $490.54 in 2018)
  • {{AUD|10|1935|round=0}}A$10 (equivalent to $491 in 2018)
  • {{AUD|10|1935|about=yes}}A$10 (equivalent to about $491 in 2018)
  • {{AUD|1000|1935|round=2}}A$1,000 (equivalent to $49,054.05 in 2018)
  • {{AUD|1000|1935|round=-2}}A$1,000 (equivalent to $49,100 in 2018)
  • {{AUD|1000|1935|round=-2|about=yes}}A$1,000 (equivalent to about $49,100 in 2018)

Redirects here

See also