View source for Template:Change/doc

{{Documentation subpage}}
===Use===
This template calculates the percent change between two [[real number]] values and displays the result in a sortable format.

The syntax for this template is as follows.

<code><nowiki>{{</nowiki>change|''1st No.''|''2nd No.''|dec=''rounding''|pre=''prefix''|suf=''suffix''|sort=''on/off''|italics=''on/off''|bold=''on/off''|invert=''on/off''|disp=''row/out''|rowspan=''rowspan''|align=''alignment''|bgcolour=''background colour''}}</code>

{|class=wikitable
|-
!parameter
!function
|-
|<code>1</code>||''1st No.'' is the first number displayed representing the base value.
|-
|<code>2</code>||''2nd No.'' is the second number displayed representing the object value.
|-
|<code>dec</code>||This is the number of decimal places to round the percentage change to.
|-
|<code>pre</code>||This adds a prefix to the first and second numbers.
|-
|<code>suf</code>||This adds a suffix to the first and second numbers.
|-
|<code>sort</code>||This adds or removes the {{tl|nts}}-compatible sort key from the first two cells.  The default is only to add this if a prefix or suffix is used (i.e. only if needed).
|-
|<code>italics</code>||This can either have the value of <code>on</code> or <code>off</code>.  <code>italics=on</code> makes the output italic.  The default is <code>italics=off</code>.
|-
|<code>bold</code>||This can either have the value of <code>on</code> or <code>off</code>.  <code>bolds=on</code> makes the output bold.  The default is <code>bold=off</code>.
|-
|<code>invert</code>||This can either have the value of <code>on</code> or <code>off</code>.  <code>invert=on</code> switches the base and object values in the calculation of percentage change.  The default is <code>invert=off</code>.
|-
|<code>align</code>||This adjusts the alignment of text in cells.  <code>align=center</code> and <code>align=left</code> aligns the text to the centre and left respectively.  The default is <code>align=right</code>.
|-
|<code>rowspan</code>||This adjust the row span of cells.  The default is  <code>rowspan=1</code>.
|-
|<code>bgcolour</code>||This adjusts the background colour of cells.  The default is <code>bgcolour=#F9F9F9</code> (light grey).
|-
|<code>disp</code>||This controls what is output.  <code>disp=out</code> produces the percentage change only (and thus <code>align</code>, <code>rowspan</code> and <code>bgcolour</code> do not work with <code>disp=out</code>).  The default is <code>disp=row</code> which produces three cells in a table row.
|}

The following sortable tables illustrate the use of this template.
{|
|-
!<big>[[Wiki markup]]</big>
!
!colspan=4|<big>Tables</big>
|-
|rowspan=2|
<pre>
{|class="wikitable sortable"
!Region
!first
!second
!change
|-
|Big Meadow
|{{change|1830000|1900679.75}}
|-
|Little Meadow
|{{change|400000|500000}}
|-
|Mount Acme
|{{change|2450000|2205678.37}}
|-
|Acmevale North
|{{change|1250000|1000000|rowspan=2}}
|-
|Acmevale South
|-
|Homeport
|{{change|5120000|5589462.60|dec=0}}
|-
|Longwood
|{{change|930000|930027.92|dec=3}}
|-
|Meadowbrook
|{{change|2450000|2450000.00|pre=$}}
|-
|Johnstown
|{{change|3400000|3902340.05|suf=&nbsp;kg}}
|-
|Lakewood
|{{change|2250000|2236005.56|align=center}}
|-
| style="background-color:lightblue" |Fox Hollow
|{{change|1180000|1190345.32|bgcolour=lightblue}}
|-
|Riverton
|{{change|10550000|11236005.55|bold=on}}
|-
|Timber Creek
|{{change|1360000|1310948.30|italics=on}}
|-
|Terminated
|{{change|1500|0.00|bold=on|italics=on}}
|-
|Upstart
|{{change|0|26250.50|align=left}}
|-
|}
</pre>
|width=100|
|
|
;Without extra code
{|class="wikitable sortable"
!Region
!first
!second
!change
|-
|Big Meadow
|{{change|1830000|1900679.75}}
|-
|Little Meadow
|{{change|400000|500000}}
|-
|Mount Acme
|{{change|2450000|2205678.37}}
|-
|Acmevale North
|{{change|1250000|1000000|rowspan=2}}
|-
|Acmevale South
|-
|Homeport
|{{change|5120000|5589462.60|dec=0}}
|-
|Longwood
|{{change|930000|930027.92|dec=3}}
|-
|Meadowbrook
|{{change|2450000|2450000.00|pre=$}}
|-
|Johnstown
|{{change|3400000|3902340.05|suf=&nbsp;kg}}
|-
|Lakewood
|{{change|2250000|2236005.56|align=center}}
|-
| style="background-color:lightblue" |Fox Hollow
|{{change|1180000|1190345.32|bgcolour=lightblue}}
|-
|Riverton
|{{change|10550000|11236005.55|bold=on}}
|-
|Timber Creek
|{{change|1360000|1310948.30|italics=on}}
|-
|Terminated
|{{change|1500|0.00|bold=on|italics=on}}
|-
|Upstart
|{{change|0|26250.50|align=left}}
|}
|width=100|
|
;With <code>{{!}}disp=out</code>
{|class="wikitable sortable"
|-
!Region
!change
|-
|Big Meadow
|{{change|1830000|1900679.75|disp=out}}
|-
|Little Meadow
|{{change|400000|500000|disp=out}}
|-
|Mount Acme
|{{change|2450000|2205678.37|disp=out}}
|-
|Acmevale North
|{{change|1250000|1000000|disp=out|rowspan=2}}
|-
|Acmevale South
|-
|Homeport
|{{change|5120000|5589462.60|dec=0|disp=out}}
|-
|Longwood
|{{change|930000|930027.92|dec=3|disp=out}}
|-
|Meadowbrook
|{{change|2450000|2450000.00|pre=$|disp=out}}
|-
|Johnstown
|{{change|3400000|3902340.05|suf=&nbsp;kg|disp=out}}
|-
|Lakewood
|{{change|2250000|2236005.56| style="text-align:center;" |disp=out}}
|-
| style="background-color:lightblue" |Fox Hollow
|{{change|1180000|1190345.32|bgcolour=lightblue|disp=out}}
|-
|Riverton
|{{change|10550000|11236005.55|bold=on|disp=out}}
|-
|Timber Creek
|{{change|1360000|1310948.30|italics=on|disp=out}}
|-
|Terminated
|{{change|1500|0.00|bold=on|italics=on|disp=out}}
|-
|Upstart
|{{change|0|26250.50| style="text-align:left;" |disp=out}}
|}
|-
|||
|
;With <code>{{!}}invert=on</code>
{|class="wikitable sortable"
!Region
!first
!second
!change
|-
|Big Meadow
|{{change|1830000|1900679.75|invert=on}}
|-
|Little Meadow
|{{change|400000|500000|invert=on}}
|-
|Mount Acme
|{{change|2450000|2205678.37|invert=on}}
|-
|Acmevale North
|{{change|1250000|1000000|invert=on|rowspan=2}}
|-
|Acmevale South
|-
|Homeport
|{{change|5120000|5589462.60|dec=0|invert=on}}
|-
|Longwood
|{{change|930000|930027.92|dec=3|invert=on}}
|-
|Meadowbrook
|{{change|2450000|2450000.00|pre=$|invert=on}}
|-
|Johnstown
|{{change|3400000|3902340.05|suf=&nbsp;kg|invert=on}}
|-
|Lakewood
|{{change|2250000|2236005.56| style="text-align:center;" |invert=on}}
|-
| style="background-color:lightblue" |Fox Hollow
|{{change|1180000|1190345.32|bgcolour=lightblue|invert=on}}
|-
|Riverton
|{{change|10550000|11236005.55|bold=on|invert=on}}
|-
|Timber Creek
|{{change|1360000|1310948.30|italics=on|invert=on}}
|-
|Terminated
|{{change|1500|0.00|bold=on|italics=on|invert=on}}
|-
|Upstart
|{{change|0|26250.50| style="text-align:left;" |invert=on}}
|}
|||
;With <code>{{!}}invert=on</code> and <code>{{!}}disp=out</code>
{|class="wikitable sortable"
!Region
!change
|-
|Big Meadow
|{{change|1830000|1900679.75|disp=out|invert=on}}
|-
|Little Meadow
|{{change|400000|500000|disp=out|invert=on}}
|-
|Mount Acme
|{{change|2450000|2205678.37|disp=out|invert=on}}
|-
|Acmevale North
|{{change|1250000|1000000|disp=out|invert=on|rowspan=2}}
|-
|Acmevale South
|-
|Homeport
|{{change|5120000|5589462.60|dec=0|disp=out|invert=on}}
|-
|Longwood
|{{change|930000|930027.92|dec=3|disp=out|invert=on}}
|-
|Meadowbrook
|{{change|2450000|2450000.00|pre=$|disp=out|invert=on}}
|-
|Johnstown
|{{change|3400000|3902340.05|suf=&nbsp;kg|disp=out|invert=on}}
|-
|Lakewood
|{{change|2250000|2236005.56| style="text-align:center;" |disp=out|invert=on}}
|-
| style="background-color:lightblue" |Fox Hollow
|{{change|1180000|1190345.32|bgcolour=lightblue|disp=out|invert=on}}
|-
|Riverton
|{{change|10550000|11236005.55|bold=on|disp=out|invert=on}}
|-
|Timber Creek
|{{change|1360000|1310948.30|italics=on|disp=out|invert=on}}
|-
|Terminated
|{{change|1500|0.00|bold=on|italics=on|disp=out|invert=on}}
|-
|Upstart
|{{change|0|26250.50| style="text-align:left;" |disp=out|invert=on}}
|}
|}

This template uses [[Module:Math]] and [[Template:ntsh]], and produces a sort compatible with [[Template:nts]] and [[Template:ntsh]].

<includeonly>
[[Category:Mathematical formatting templates]]
[[Category:Mathematical function templates]]
[[Category:Sorting templates]]
</includeonly>