|
Update documentation for the new wmpty lines-less behaviour.
|
Explanation now deals with the two possible dataset types
|
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
This sub-template contains a country/region inflation table |
This sub-template either contains a country/region inflation table or calls one locatedin another sub-template. It's output is used by the {{tl|Inflation}} template and possibly others. It's not meant to be called directly, but if you do, it'll produce one or more lines containing each a number preceded by an asterisk (the multiply character) for use in <tt><nowiki>{{</nowiki>[[m:Help:ParserFunctions#.23expr:|#expr:]]<nowiki>}}</nowiki></tt> and related [[m:Help:ParserFunctions|parser functions]]: |
||
* 1.020 |
* 1.020 |
||
| Line 10: | Line 10: | ||
{{tlx|{{PAGENAME}}|year1|year2}} |
{{tlx|{{PAGENAME}}|year1|year2}} |
||
Where '''year1''' and '''year2''' determine the range of "''multiply by n''" lines that will be returned. |
Where '''year1''' and '''year2''' determine the range of "''multiply by n''" lines or the [[Consumer price index|CPI]] division that will be returned. |
||
Failing to provide one or both parameters, providing an ''year2'' lower than ''year1'', or providing an ''year1'' and an ''year2'' that are both lower than the lowest or higher than the highest year in the table, |
Failing to provide one or both parameters, providing an ''year2'' lower than ''year1'', or providing an ''year1'' and an ''year2'' that are both lower than the lowest or higher than the highest year in the table, is an undefined operation that will result in either an "* 1" or an empty string, depending on how the dataset is constructed. Similarly, providing an ''year1'' lower than the lowest year in the table, and an ''year2'' higher than the highest year in the table, will either also return "* 1", or the whole table. Providing any non-numeric parameter will result in one or more red errors that should be handled with the <tt><nowiki>{{</nowiki>[[m:Help:ParserFunctions#.23iferror:|#iferror:]]<nowiki>}}</nowiki></tt> parser function. |
||
=== See also === |
=== See also === |
||
This sub-template either contains a country/region inflation table or calls one located in another sub-template. It's output is used by the {{Inflation}} template and possibly others. It's not meant to be called directly, but if you do, it'll produce one or more lines containing each a number preceded by an asterisk (the multiply character) for use in {{#expr:}} and related parser functions:
* 1.020 * 0.999 * 1.002
{{Inflation/doc/table|year1|year2}}
Where year1 and year2 determine the range of "multiply by n" lines or the CPI division that will be returned.
Failing to provide one or both parameters, providing an year2 lower than year1, or providing an year1 and an year2 that are both lower than the lowest or higher than the highest year in the table, is an undefined operation that will result in either an "* 1" or an empty string, depending on how the dataset is constructed. Similarly, providing an year1 lower than the lowest year in the table, and an year2 higher than the highest year in the table, will either also return "* 1", or the whole table. Providing any non-numeric parameter will result in one or more red errors that should be handled with the {{#iferror:}} parser function.
