الگو:Inflation/توضیحات

از ویکی‌پدیا، دانشنامهٔ آزاد
پرش به: ناوبری، جستجو

This template takes a country_code, for example, "US" for the ایالات متحده آمریکا or "UK" for بریتانیا, a value in that country's currency, a start_year, and applies to it the country's شاخص قیمت مصرف کننده until "recently".[۱] 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}}

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

Country name country_code minimum for start_year
استرالیا[۲] AU 1901
کانادا[۳] CA 1916
آلمان[۴] DE 1882
بریتانیا[۵] UK 1264
ایالات متحده آمریکا[۶] US 1800
  • end_year, 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).

Examples:

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

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 (NaN) 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}} = خطای عبارت: نویسه نقطه‌گذاری شناخته نشده «[»

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 NaN.00
  • Green tickY £{{formatnum:{{Inflation|UK|1000000|1323|1978|r=-4}}}} = £NaN
  • Green tickY ${{formatnum:{{Inflation|US|1000000|1990|r=2}}}} = $NaN

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}}}} = $NaN
  • Red XN ${{formatnum:{{Inflation|US|1000000|1900|r=-5}}}} thousand = $NaN thousand
  • Green tickY ${{formatnum:{{Inflation|US|1000|1900|r=-2}}}} million = $NaN million
  • Green tickY ${{formatnum:{{Inflation|US|1|1900|r=1}}}} billion = $NaN 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".

On the down side, {{Formatprice}} has no built-in intelligent handling of user locale settings, which means that some users might see a dot or a comma the opposite way they'd expect. As a general rule of thumb this shouldn't be a serious concern though, as most numbers in Wikipedia are hand-written anyway and will show as entered regardless of user settings.

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 countries 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. Last modified 2011-01-25. Retrieved January 16, 2012
  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–2013. Federal Reserve Bank of Minneapolis. Retrieved March 31, 2013.