ಟೆಂಪ್ಲೇಟು:Inflation/doc

ವಿಕಿಪೀಡಿಯ ಇಂದ
Jump to navigation Jump to search
This documentation subpage contains instructions, categories, or other information that is not part of the ಟೆಂಪ್ಲೇಟು. To view the ಟೆಂಪ್ಲೇಟು page itself, see ಟೆಂಪ್ಲೇಟು:Inflation.

This template takes a country_code, for example, "US" for the United States or "UK" for United Kingdom, a value in that country's currency, a start_year, and applies to it the country's consumer price inflation until "recently" or another end year.[೧] For example, this template calls the U.S. inflation table located in the sub-template Template:Inflation/US/dataset to perform the U.S. calculation. This means that whenever a new year arrives and the inflation tables are updated, all articles using this template have their displayed values updated accordingly.

Alternatively, you can provide a second, optional end_year parameter, and the value will be inflated for the period between the two years, providing a convenient way of getting values from different time periods adjusted around the same date.

Usage[ಬದಲಾಯಿಸಿ]

{{Inflation|country_code|value|start_year|r=digit}}
{{Inflation|country_code|value|start_year|end_year|r=digit}}
{{Inflation|country_code|value|start_year|r=digit}}
{{Inflation|country_code|value|start_year|r=digit}}

The supported countries are listed below, with their country_code and minimum start_year:

Country name country_code minimum for start_year
Australia[೨] AU 1901
Canada[೩] CA 1916
Germany[೪] DE 1882
United Kingdom[೫] UK 1264
United States[೬] US 1800

Parameters[ಬದಲಾಯಿಸಿ]

  • country_code (parameter 1) can be: AU, CA, DE, UK, US, UKNGDPPC, etc.
  • value (parameter 2) can have commas, but no currency symbol.
  • start_year (parameter 3) depends on years allowed for each country.
  • end_year (parameter 4), if provided, must be higher (later) than start_year, but not higher than the current year, and will default to "recently" if left out;
  • r=digit sets the digit in which the value must be rounded, defaulting to "0" if unspecified, i.e., without cents (see Tips & Tricks below for details on how to use this parameter).
  • fmt=c will insert commas into the inflated value.
  • fmt=eq will show an equivalent-to phrase.
  • cursign=X will set the currency symbol when 'fmt=eq' is used (default: $).

Examples:

  • Green tickY {{Inflation|DE|1000000|2000}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 2000. 
  • Green tickY {{Inflation|US|1000000|2001|2001}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 2001. 
  • Green tickY {{Inflation|US|1000000|1990|2005|r=2}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 1990. 
  • Green tickY {{Inflation|UK|1000000|1323|1978|r=-3}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 1323. 

Entering invalid parameters will result in a link to the NaN article:

  • Red XN {{Inflation}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: {{{2}}} or year: {{{3}}}. 
  • Red XN {{Inflation|abc}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"[".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: {{{2}}} or year: {{{3}}}. 
  • Red XN {{Inflation|DE|1000000}} = ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: {{{3}}}. 
  • Red XN {{Inflation|US|1000000|1200|3000}} =
    {Inflation} - Year: 1200 lower than US minimum, 1800, for amount: 1000000. ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 1200. 
  • Red XN {{Inflation|UK|1000000|2005|2004}} =
    {Inflation} - Start year: 2005 greater than end year, 2004 for amount: 1000000. ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000000 or year: 2005. 

Tips & Tricks[ಬದಲಾಯಿಸಿ]

Currency conversion[ಬದಲಾಯಿಸಿ]

This template is currency agnostic, which means it doesn't convert between different currencies. Thus, if you wanted to know how much DM 1,000.00 marks in 1960 are worth nowadays, entering {{Inflation|DE|1000|1960|r=2}} would provide a result (ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨".{Inflation} - NaN check amount: 1000 or year: 1960. ) still in marks, not in euros.

Consequently, if you need a result in another currency than the one in which the original value is stated, for now you must do the conversion manually, as in the following example which uses the defined conversion rate of € 1 = DM 1.95583:

  • Green tickY {{#expr:({{Inflation|DE|1000|1960|r=2}} / 1.95583) round 2}} = Expression error: Unexpected < operator.

A currency conversion template to ease these conversion tasks is planned. This section will be updated accordingly once it's developed.

Rounding[ಬದಲಾಯಿಸಿ]

By default the values are calculated to the unit, as for most huge values cents are undesirable. If you need a different precision you can provide the |r= parameter to determine in which digit the rounding must happen. To obtain cents you'd use |r=2, but other values can be used, including negative ones: |r=-3, for example, will round to the nearest thousand, |r=-6 to the nearest million, and so on and so forth.

Formatnum[ಬದಲಾಯಿಸಿ]

For a better visualization you can format the returned value using either the internal {{formatnum:}} magic word, or the alternative {{Formatprice}} template (see below). Each method has its advantages and disadvantages.

{{formatnum:}} is the standard method for formatting numbers in MediaWiki. It adds thousands and decimal separators according to the user settings, and works well for raw numbers composed of up to 15 digits and a dot. On the other hand, it doesn't allow one to set how many digits must be shown after the decimal dot. Thus, a calculated value of "1234.5" will appear as "೧,೨೩೪.೫", not the expected "1,234.50", making it better suited for integer prices unless the value is known and you can add the missing zeros by hand:

  • Green tickY DM {{formatnum:{{Inflation|DE|1000000|1957|1978}}}}.00 = DM <s,tr,ong..00
  • Green tickY £{{formatnum:{{Inflation|UK|1000000|1323|1978|r=-4}}}} = £<s,tr,ong.
  • Green tickY ${{formatnum:{{Inflation|US|1000000|1990|r=2}}}} = $<s,tr,ong.

Another potential source of difficulties resides in the way certain calculated values are expressed. In many cases the result comes as a number in engineering units ("1.2E+9" instead of "1200000000"), and when that happens {{formatnum:}}'ing the result fails. A workaround then is to express the value to be inflated with fewer digits, adding a multiplier text such as "million" after the result, and then hitting the "Show preview" button as many times as needed, changing parameters until the best result is found:

  • Red XN ${{formatnum:{{Inflation|US|1000000000|1900|r=-8}}}} = $<,st,ro,ng, cl.
  • Red XN ${{formatnum:{{Inflation|US|1000000|1900|r=-5}}}} thousand = $<s,tr,ong. thousand
  • Green tickY ${{formatnum:{{Inflation|US|1000|1900|r=-2}}}} million = $<,str. million
  • Green tickY ${{formatnum:{{Inflation|US|1|1900|r=1}}}} billion = $<. billion

The following section provides an automated way of avoiding this trial and error scenario.

Formatprice[ಬದಲಾಯಿಸಿ]

{{Formatprice}} is a template specifically designed to display price values, both big and small, in a more pleasant way than {{formatnum:}} allows for. For example, instead of showing the whole of a huge number such as "953,783,409,856.12", it would show it as "954 billion", while small numbers have their cents part appearing as expected, "1234.5" being properly shown as "1.23 thousand".

Documenting[ಬದಲಾಯಿಸಿ]

It's a good practice to provide a valid reference for the prices calculated with this template in the articles where it's used. The template {{Inflation-fn}} was developed to ease this task. It accepts as its single parameter the same country codes used here, and will generate one or more appropriate footnotes. Typically, this is how a piece of text using it looks like:

  • In 1910 a ''blah'' cost on average £1,000. This is equivalent to £{{Formatprice|{{Inflation|UK|1000|1910|r=2}}}} in present day terms.{{Inflation-fn|UK}}

Resulting in this converted code (notice the footnote link at the end):

  • In 1910 a blah cost on average £1,000. This is equivalent to £NaN in present day terms.[೫]

The footnote thus generated appears whenever {{reflist}} or <references /> is used in an article, usually in its "References" section. See below for the live example in this document's own References section, or click the above generated footnote to jump to it.

Limitations[ಬದಲಾಯಿಸಿ]

  1. Currently it isn't possible to "de-inflate" a value to what it would have been in a previous year. If you need this functionality, please request it at the talk page. Adding it won't be difficult, but there's no point in doing so before someone actually needs it.
  2. Substitution isn't supported at all. Trying to {{subst:Inflation|...}} would only result in a long sequence of embedded parser code without any direct benefit. If you need to obtain an inflated price only once, please use the special ExpandTemplates page then copy the result and paste it at the desired location.

Developer Documentation[ಬದಲಾಯಿಸಿ]

An inflation series represents templates in the following categories:

  • Template:Inflation/name
  • Template:Inflation/name/dataset
  • Template:Inflation/name/startyear
  • Template:Inflation/doc/name (Which is then displayed at Inflation/name/dataset as the documentation, and needs to refer to the original data source)

Modifications need to be made to:

  • Template:Inflation-fn

See also[ಬದಲಾಯಿಸಿ]

References[ಬದಲಾಯಿಸಿ]

  1. How recently depends on how the data set for each country is constructed, and on the internal tables being updated accordingly every January. Some data tables provide inflation data up to December 31, ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨"., others up to roughly June-July ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨"., and others yet up to December 31, ಪದವಿನ್ಯಾಸ ದೋಷ: ಗುರುತಿಸಲಾಗದ ವಿರಾಮ ಚಿಹ್ನೆ"೨"..
  2. Australian Consumer Price Inflation figures follow the Long Term Linked Series provided in Australian Bureau of Statistics (2009) 6461.0 – Consumer Price Index: Concepts, Sources and Methods, 2009 as explained at §§3.10–3.11; this series comprises "from 1901 to 1914, the A Series Retail Price Index; from 1914 to 1946–47, the C Series Retail Price Index; from 1946-47 to 1948-49, a combination of the C Series Index, excluding rent, and the housing group of the CPI; and from 1948–49 onwards, the CPI." (3.10)
  3. Canadian inflation numbers based on Statistics Canada. "Consumer Price Index, historical summary". CANSIM, table (for fee) 326-0021 and Catalogue nos. 62-001-X, 62-010-X and 62-557-X. And Consumer Price Index, by province (monthly) (Canada) Last modified 2013-12-20. Retrieved January 8, 2014
  4. German inflation numbers based on data available from Deutsches Statistisches Bundesamt.
  5. ೫.೦ ೫.೧ UK CPI inflation numbers based on data available from Gregory Clark (2013), "What Were the British Earnings and Prices Then? (New Series)" MeasuringWorth.
  6. Consumer Price Index (estimate) 1800–2014. Federal Reserve Bank of Minneapolis. Retrieved February 27, 2014.