Visa källa för Mall:Inflation/dok

{{Dokumentationssida}}
{{Komplicerad kod}}

{| align="right"
 | __TOC__
 |}
Denna mall använder paramaterarna <tt>[[ISO 3166|landskod]]</tt>, exempelvis, "<tt>US</tt>" för [[USA]]  eller "<tt>UK</tt>" för [[Storbritannien]], ett <tt>värde</tt> i landets valuta, ett <tt>startår</tt>, och applicerar detta på landets [[konsumentprisindex|prisinflation]] fram till "nutid".<ref>Hur nära i nutid beror på hur datan för varje land är sammansatt och på interna tabeller som ska uppdateras i början av varje år. Några datatabeller ger inflationsdata fram till 31 december {{#expr:{{CURRENTYEAR}}-1}}, andra till omkring juni-juli {{#expr:{{CURRENTYEAR}}-1}}, och andra till och med 31 december {{#expr:{{CURRENTYEAR}}-2}}.</ref> Detta betyder att närhelst ett nytt år inleds, kommer alla artiklar som använder denna mall få deras visade värde uppdaterat.

Alternativt kan man, om man vill, ange parametern <tt>slutår</tt>. Värdet kommer då beräknas mellan två år, vilket ger en bekväm väg att få värden från olika tidsperioder justerade kring samma år.

=== Användning ===

 {{Mall|Inflation|landskod|värde|startår|r{{=}}digit}}
 {{Mall|Inflation|landskod|värde|startår|slutår|r{{=}}digit}}

Där:

* '''landskod''' och '''startår''' kan se ut som följer:

{|class="wikitable sortable"
! ''Country name'' !! <tt>country_code</tt> !! <tt>start_year</tt>
|-
| [[Tyskland]]{{inflation-fn|DE}}        || align="center" | '''DE''' || align="center" | 1882
|-
| [[Storbritannien]]{{inflation-fn|UK}} || align="center" | '''UK''' || align="center" | 1264
|-
| [[USA]]{{inflation-fn|US}}  || align="center" | '''US''' || align="center" | 1800
|}

* '''slutår''', om angivet, måste vara högre (senare) än '''startår''', men inte högre än innevarande år, och kommer automatiskt vara "nutid" om utelämnat;
* '''r='''''digit'' anger antalet decimaler som värdet ska rundas av till, satt till "0" om det ej angetts, i.e., utan hundradelar (se [[Template:Inflation#Tips & Tricks|Tips & Tricks]] nedan för dealjer om hur man använder denna parameter).

Exempel:

* {{J2}} {{Mall|Inflation|DE|1000000|2000}} = {{Inflation|DE|1000000|2000}}
* {{J2}} {{Mall|Inflation|US|1000000|2001|2001}} = {{Inflation|US|1000000|2001|2001}}
* {{J2}} {{Mall|Inflation|US|1000000|1990|2005|r{{=}}2}} = {{Inflation|US|1000000|1990|2005|r=2}}
* {{J2}} {{Mall|Inflation|UK|1000000|1323|1978|r{{=}}-3}} = {{Inflation|UK|1000000|1323|1978|r=-3}}

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

* {{N2}} {{Mall|Inflation}} = {{Inflation}}
* {{N2}} {{Mall|Inflation|abc}} = {{Inflation|abc}}
* {{N2}} {{Mall|Inflation|DE|1000000}} = {{Inflation|DE|1000000}}
* {{N2}} {{Mall|Inflation|US|1000000|1200|3000}} = {{Inflation|US|1000000|1200|3000}}
* {{N2}} {{Mall|Inflation|UK|1000000|2005|2004}} = {{Inflation|UK|1000000|2005|2004}}



== Användning ==
==== Tips & Trick ====
===== Valutaomvandling =====
Denna mall är valitabunden, vilket betyder att den inte konverterar mellan olika valutor. Detta innebär att om du ville veta hur många 1 000 D-mark 1960 är värt idag, genom att ange {{Mall|Inflation|DE|1000|1960|r{{=}}2}} skulle du få resultatet (''{{Inflation|DE|1000|1960|r=2}}'') vilket fortfarande är i mark, ej i euro.

Följaktligen innebär detta att om du behöver ett resultat i en annan valuta än den som den ursprungliga, måste du för närvarande göra omvandlingen manuellt och i följande exempel som använder det egna angivna omvandlingsvärdet 1 € = 1.95583 D-mark:

* {{J2}} <tt><nowiki>{{#expr:</nowiki>({{Mall|Inflation|DE|1000|1960|r{{=}}2}}<nowiki> / 1.95583) round 2}}</nowiki></tt> = {{#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 {{para|r}} parameter to determine in which digit the rounding must happen. To obtain cents you'd use {{para|r|2}}, but other values can be used, including negative ones: {{para|r|-3}}, for example, will round to the nearest thousand, {{para|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 <tt><nowiki>{{</nowiki>[[Help:Magic words#Formatting|formatnum:]]<nowiki>}}</nowiki></tt> magic word, or the alternative {{tlx|Formatprice}} template ([[Template:Inflation#Formatprice|see below]]). Each method has its advantages and disadvantages.

<tt><nowiki>{{</nowiki>[[Help:Magic words#Formatting|formatnum:]]<nowiki>}}</nowiki></tt> is the standard method for formatting numbers in MediaWiki. It add 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 "{{formatnum:{{#expr:1000 + 234.5}}}}", 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:

* {{J2}} <tt>'''DM''' <nowiki>{{formatnum:</nowiki>{{tlx|Inflation|DE|1000000|1957|1978}}<nowiki>}}</nowiki>'''.00'''</tt> = DM {{formatnum:{{Inflation|DE|1000000|1957|1978}}}}.00
* {{J2}} <tt>'''£'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|UK|1000000|1323|1978|r{{=}}-4}}<nowiki>}}</nowiki></tt> = £{{formatnum:{{Inflation|UK|1000000|1323|1978|r=-4}}}}
* {{J2}} <tt>'''$'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|US|1000000|1990|r{{=}}2}}<nowiki>}}</nowiki></tt> = ${{formatnum:{{Inflation|US|1000000|1990|r=2}}}}

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 <tt><nowiki>{{</nowiki>[[Help:Magic words#Formatting|formatnum:]]<nowiki>}}</nowiki>'ing</tt> the result fails. A workaround then is to express the value to be inflated with less 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:

* {{N2}} <tt>'''$'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|US|1000000000|1900|r{{=}}-8}}<nowiki>}}</nowiki></tt> = ${{formatnum:{{Inflation|US|1000000000|1900|r=-8}}}}
* {{N2}} <tt>'''$'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|US|1000000|1900|r{{=}}-5}}<nowiki>}}</nowiki> ''thousand''</tt> = ${{formatnum:{{Inflation|US|1000000|1900|r=-5}}}} thousand
* {{J2}} <tt>'''$'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|US|1000|1900|r{{=}}-2}}<nowiki>}}</nowiki> ''million''</tt> = ${{formatnum:{{Inflation|US|1000|1900|r=-2}}}} million
* {{J2}} <tt>'''$'''<nowiki>{{formatnum:</nowiki>{{tlx|Inflation|US|1|1900|r{{=}}1}}<nowiki>}}</nowiki> ''billion''</tt> = ${{formatnum:{{Inflation|US|1|1900|r=1}}}} billion

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

===== Formatprice =====

{{tlx|Formatprice}} is a template specifically designed to display price values, both big and small, in a more pleasant way than <tt><nowiki>{{</nowiki>[[Help:Magic words#Formatting|formatnum:]]<nowiki>}}</nowiki></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 "{{Formatprice|953783409856.12}}", while small numbers have their cents part appearing as expected, "1234.5" being properly shown as "{{Formatprice|1234.5}}".

On the down side, {{tlx|Formatprice}} has no built-in intelligent handling of user locale settings, what 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.

* {{J2}} <tt>'''DM''' <nowiki>{{</nowiki>[[Template:Formatprice|Formatprice]]<nowiki>|</nowiki>{{tlx|Inflation|DE|1000000|1957|1978}}<nowiki>}}</nowiki></tt> = DM {{Formatprice|{{Inflation|DE|1000000|1957|1978}}}}
* {{J2}} <tt>'''£'''<nowiki>{{</nowiki>[[Template:Formatprice|Formatprice]]<nowiki>|</nowiki>{{tlx|Inflation|UK|1000000|1323|1978|r{{=}}-4}}<nowiki>}}</nowiki></tt> = £{{Formatprice|{{Inflation|UK|1000000|1323|1978|r=-4}}}}
* {{J2}} <tt>'''$'''<nowiki>{{</nowiki>[[Template:Formatprice|Formatprice]]<nowiki>|</nowiki>{{tlx|Inflation|US|1000000|1990|r{{=}}2}}<nowiki>}}</nowiki></tt> = ${{Formatprice|{{Inflation|US|1000000|1990|r=2}}}}
* {{J2}} <tt>'''$'''<nowiki>{{</nowiki>[[Template:Formatprice|Formatprice]]<nowiki>|</nowiki>{{tlx|Inflation|US|1000000000|1900|r{{=}}-8}}<nowiki>}}</nowiki></tt> = ${{Formatprice|{{Inflation|US|1000000000|1900|r=-8}}}}

===== 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 {{tl|Inflation-fn|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:

* <tt><nowiki>In 1910 a ''blah'' cost on average £1,000. This is equivalent to £{{Formatprice|{{Inflation|</nowiki>'''UK'''<nowiki>|1000|1910|r=2}}}} in present day </nowiki>{{Nowrap|terms.<nowiki>{{Inflation-fn|</nowiki>'''UK'''<nowiki>}}</nowiki>}}</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 £{{Formatprice|{{Inflation|UK|1000|1910|r=2}}}} in present day terms.{{Inflation-fn|UK}}

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



==== Limitations ====

#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 [[Template talk:Inflation|talk page]]. Adding it won't be difficult, but there's no point in doing so before someone actually needs it.
#[[Wikipedia:Template substitution|Substitution]] isn't supported at all. Trying to <tt><nowiki>{{subst:</nowiki>[[Template:Inflation|Inflation]]<nowiki>|...}}</nowiki></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 [[Special:ExpandTemplates|ExpandTemplates]] page then copy the result and paste it at the desired location.

=== Parametrar ===

=== Exempel ===

=== Associerad kategori ===
<!-- VID BEHOV KAN MAN HÄR LÄGGA TILL:
Artiklar med denna mall placeras i [[:Kategori:XXX]].
-->

== Källor ==
<references/>

== Se även ==
* {{tl|Inflation-fn}}
* {{tl|Formatprice}}
* [[Inflation]]
* [[Konsumentprisindex]]
* [[Harmoniserat konsumentprisindex]]
* [[ISO_3166-1|Landskoder enligt internationell standard (ISO 3166-1)]]
* [[Lista över länders valutor]]

<includeonly>
<!-- KATEGORIER NEDAN -->
{{DEFAULTSORT:{{BASEPAGENAME}}}}<!-- UTRIKISKA KATEGORIER
[[Kategori:Currency conversion templates]]
[[Kategori:Economics formatting and function templates]]
[[Kategori:Finance formatting and function templates]]
[[Kategori:Miscellaneous templates]]
[[Kategori:United States templates]]-->
<!-- INTERWIKI NEDAN -->
</includeonly>
[[bn:টেমপ্লেট:Inflation]]
[[de:Vorlage:Inflation]]
[[en:Template:Inflation]]
[[es:Plantilla:Inflacción]]
[[it:Template:Inflazione]]
[[ml:ഫലകം:Inflation]]
[[ne:ढाँचा:Inflation]]
[[pl:Szablon:Inflacja]]
</includeonly><noinclude>
[[de:Vorlage:Inflation/Doku]]
[[en:Template:Inflation/doc]]
[[pl:Szablon:Inflacja/opis]]
</noinclude>