View source for Template:Inflation/fn/doc

{{documentation subpage}}
{{High-use}}
Provides standard article footnotes for documenting the source of the inflated prices calculated by {{tlx|Inflation}}.

== Usage ==
  {{tlx|Inflation/fn}}
  {{tlx|Inflation/fn|''index''}}
  {{tlx|Inflation/fn|''index''|3=group=''groupname''}}

When the '''index''' parameter is provided, a footnote about that specific data set is generated. The index codes are the same as those used by {{tlx|Inflation}}:

* {{tlx|Inflation/fn|AR}} = {{Inflation/fn|AR}}
* {{tlx|Inflation/fn|AT}} = {{Inflation/fn|AT}}
* {{tlx|Inflation/fn|AU}} = {{Inflation/fn|AU}}
** {{tlx|Inflation/fn|AU-road}} = {{Inflation/fn|AU-road}}
* {{tlx|Inflation/fn|BD}} = {{Inflation/fn|BD}}
* {{tlx|Inflation/fn|BE}} = {{Inflation/fn|BE}}
* {{tlx|Inflation/fn|BR}} = {{Inflation/fn|BR}}
* {{tlx|Inflation/fn|CA}} = {{Inflation/fn|CA}}
* {{tlx|Inflation/fn|CH}} = {{Inflation/fn|CH}}
* {{tlx|Inflation/fn|CL}} = {{Inflation/fn|CL}}
* {{tlx|Inflation/fn|CN}} = {{Inflation/fn|CN}}
* {{tlx|Inflation/fn|DE}} = {{Inflation/fn|DE}}
* {{tlx|Inflation/fn|DK}} = {{Inflation/fn|DK}}
* {{tlx|Inflation/fn|EG}} = {{Inflation/fn|EG}}
* {{tlx|Inflation/fn|ES}} = {{Inflation/fn|ES}}
* {{tlx|Inflation/fn|FI}} = {{Inflation/fn|FI}}
* {{tlx|Inflation/fn|FR}} = {{Inflation/fn|FR}}
* {{tlx|Inflation/fn|GR}} = {{Inflation/fn|GR}}
* {{tlx|Inflation/fn|HK}} = {{Inflation/fn|HK}}
* {{tlx|Inflation/fn|ID}} = {{Inflation/fn|ID}}
* {{tlx|Inflation/fn|IL}} = {{Inflation/fn|IL}}
* {{tlx|Inflation/fn|IN}} = {{Inflation/fn|IN}}
* {{tlx|Inflation/fn|IR}} = {{Inflation/fn|IR}}
* {{tlx|Inflation/fn|IS}} = {{Inflation/fn|IS}}
* {{tlx|Inflation/fn|IT}} = {{Inflation/fn|IT}}
* {{tlx|Inflation/fn|JP}} = {{Inflation/fn|JP}}
* {{tlx|Inflation/fn|KRW}} = {{Inflation/fn|KRW}}
* {{tlx|Inflation/fn|MX}} = {{Inflation/fn|MX}}
* {{tlx|Inflation/fn|NL}} = {{Inflation/fn|NL}}
* {{tlx|Inflation/fn|NO}} = {{Inflation/fn|NO}}
* {{tlx|Inflation/fn|NZ}} = {{Inflation/fn|NZ}}
* {{tlx|Inflation/fn|PE}} = {{Inflation/fn|PE}}
* {{tlx|Inflation/fn|PH}} = {{Inflation/fn|PH}}
* {{tlx|Inflation/fn|PK}} = {{Inflation/fn|PK}}
* {{tlx|Inflation/fn|PL}} = {{Inflation/fn|PL}}
* {{tlx|Inflation/fn|PT}} = {{Inflation/fn|PT}}
* {{tlx|Inflation/fn|RU}} = {{Inflation/fn|RU}}
* {{tlx|Inflation/fn|SE}} = {{Inflation/fn|SE}}
* {{tlx|Inflation/fn|SG}} = {{Inflation/fn|SG}}
* {{tlx|Inflation/fn|TH}} = {{Inflation/fn|TH}}
* {{tlx|Inflation/fn|TR}} = {{Inflation/fn|TR}}
* {{tlx|Inflation/fn|TW}} = {{Inflation/fn|TW}}
<!-- * {{tlx|Inflation/fn|TEST}} = {{Inflation/fn|TEST}} -->
* {{tlx|Inflation/fn|UK}} = {{Inflation/fn|UK}}
** {{tlx|Inflation/fn|UK-GDP}} = {{Inflation/fn|UK-GDP}}
* {{tlx|Inflation/fn|US}} = {{Inflation/fn|US}}
** {{tlx|Inflation/fn|US-GDP}} = {{Inflation/fn|US-GDP}}
* {{tlx|Inflation/fn|VN}} = {{Inflation/fn|VN}}
* {{tlx|Inflation/fn|ZAR}} = {{Inflation/fn|ZAR}}

When '''no''' <code>index</code> parameter is provided, or when an invalid index is provided, a generic footnote is generated with an error:

* {{tlx|Inflation/fn}} = {{Inflation/fn}}
* {{tlx|Inflation/fn|xyz}} = {{Inflation/fn|xyz}}

This is the reference list generated by the above examples:
{{reflist|33em}}

Anchor names produced are based on the index parameter, or its lack thereof. As a result, the same {{tlx|Inflation/fn|index}} code can be used many times in the same article while generating only one actual footnote per index code.

===Reference grouping===
If it is desired to place the footnote into a [[WP:REFGROUP|reference group]] other than the default, the {{para|group}} parameter may be used:

* {{tlx|Inflation/fn|UK|3=group=nb}} = {{Inflation/fn|UK|group=nb}}
{{reflist|group=nb}}

'''NB''' to group the footnote with other footnotes rather than references, ({{tl|notelist}}), use {{para|group|lower-alpha}}

See the [[Template:Inflation#Referencing|related section]] at {{tl|Inflation}} for additional instructions and examples.

===Date format===
Where the ''country'' is either <code>CA</code> or <code>US</code>, the generated reference includes the retrieval date of the data, which is shown in month-first (MDY) format. For <code>US</code> only, this may be altered to day-first (DMY) format by adding {{para|df|yes}}. This must be done each time the template is called in an article, or there will be an error message in the reference list.
* {{tlx|Inflation/fn|US|3=df=yes}} = {{Inflation/fn|US|df=yes}}
{{reflist|close=1}}

===Citation format===
The citations for several indexes use {{tl|cite web}} as a base template. This means the footnotes are output using [[Help:Citation Style 1|Citation Style 1]] (CS1) as a default. One (<code>IN</code>) uses {{tl|citation}} as a base template, resulting in [[Help:Citation Style 2|Citation Style 2]] (CS2) as a default. To switch between these, use {{para|mode|cs1}} or {{para|mode|cs2}} as appropriate. This must be done each time the template is called in an article, or there will be an error message in the reference list.
*{{tlx|Inflation/fn|US|3=mode=cs2}} = {{Inflation/fn|US|mode=cs2}}
*{{tlx|Inflation/fn|IN|3=mode=cs1}} = {{Inflation/fn|IN|mode=cs1}}
{{reflist|close=1}}

===Name list styles===
This template supports {{para|name-list-style}} to promote consistency with other citations in an article.
*{{tlx|Inflation/fn|US-GDP|3=name-list-style=amp}} = {{Inflation/fn|US-GDP|name-list-style=amp}}
{{reflist|}}

== See also ==
* {{tl|Inflation}}
* {{tl|Inflation/year}}
* {{tl|Format price}}
* [[Help:Footnotes]]

<includeonly>{{Sandbox other||
<!--Categories below this line, please; interwikis at Wikidata-->
[[Category:Economics formatting and function templates]]
[[Category:Finance formatting and function templates]]
[[Category:United States economic templates]]
[[Category:Templates that generate named references]]

}}</includeonly>