Template:Inflation-year/doc
 | This is a documentation subpage for Template:Inflation-year. It contains usage information, categories and other content that is not part of the original template page. |
Provides a standard way of indicating the "current" year of the inflated prices calculated by {{Inflation}}. This template is relied upon by {{Inflation}}, but can also be called directly in articles needing to specify the currently most recent year for which inflation is calculated for a given index. See {{Inflation}} for usage examples.
Usage
{{Inflation-year|index}}
When the required index parameter is provided, the last year given by the inflation data is printed. The index codes are the same as those used by {{Inflation}}:
{{Inflation-year|AU}}= 2018{{Inflation-year|AU-road}}= 2018
{{Inflation-year|BD}}= 2014{{Inflation-year|CA}}= 2020{{Inflation-year|DE}}= 2017{{Inflation-year|IN}}= 2019{{Inflation-year|JP}}= 2019{{Inflation-year|PH}}= 2019{{Inflation-year|PK}}= 2019{{Inflation-year|UK}}= 2019{{Inflation-year|UK-GDP}}= 2019
{{Inflation-year|US}}= 2020{{Inflation-year|US-GDP}}= 2019
{{Inflation-year|ZAR}}= 2018
When no index parameter is provided, or when an invalid index is provided, an error is shown:
{{Inflation-year}}= Error: no index specified when using {{Inflation/year}}.- also
{{Inflation-year|ERR}}= Error: no index specified when using {{Inflation/year}}.
- also
{{Inflation-year|xyz}}= Error: undefined index "xyz" when using {{Inflation/year}}.
<templatedata>
{
"params": {
"index": {
"aliases": [
"1"
],
"label": "Index",
"description": "An index code for one of several available inflation indexes. One of AU, AU-road, BD, CA, DE, IN, JP, PH, PK, UK, UK-GDP, US, US-GDP, ZAR.",
"example": "US",
"type": "string",
"required": true
}
},
"format": "inline",
"description": "Provides a standard way of indicating the \"current\" year of the inflated prices calculated by the Inflation template. This template is relied upon by the Inflation template, but can also be called directly in articles needing to specify the currently most recent year for which inflation is calculated for a given index. See the Inflation template for usage examples."
}
</templatedata>