Template:Inflation/doc

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
The supported countries are listed below, with their country_code and minimum start_year:

Parameters

 * country_code (parameter 1) can be: AU, CA, DE, UK, US, UKNGDPPC, etc.
 * value (parameter 2) can have commas, but no currency sign.
 * 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 sign (default: $).

Examples:



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



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 would provide a result () 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:


 * ✅   =

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 2, but other values can be used, including negative ones: -3, for example, will round to the nearest thousand, -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   magic word, or the alternative  template (see below). Each method has its advantages and disadvantages.

 </tt> 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 "0", 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:


 * ✅ DM 0 .00</tt> = DM 0.00
 * ✅ £ 0 </tt> = £0
 * ✅ $ 0 </tt> = $0

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  'ing</tt> 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:


 * ❌ $ 0 </tt> = $0
 * ❌ $ 0 thousand</tt> = $0 thousand
 * ✅ $ 0 million</tt> = $0 million
 * ✅ $ 0 billion</tt> = $0 billion

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

Formatprice
is a template specifically designed to display price values, both big and small, in a more pleasant way than  </tt> 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 "", while small numbers have their cents part appearing as expected, "1234.5" being properly shown as "".

On the down side, 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.


 * ✅ DM </tt> = DM
 * ✅ £ </tt> = £
 * ✅ $ </tt> = $
 * ✅ $ </tt> = $

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 country 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 £ in present day terms.</tt>

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 £ in present day terms.

The footnote thus generated appears whenever or  </tt> 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 <tt> ... </tt> 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: Modifications need to be made to:
 * 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)
 * Template:Inflation-fn