Template:Change/doc

This is a documentation subpage for Template:Change.
It may contain usage information, categories and other content that is not part of the original template page.

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.

{{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}}

parameter	function
`1`	1st No. is the first number displayed representing the base value.
`2`	2nd No. is the second number displayed representing the object value.
`dec`	This is the number of decimal places to round the percentage change to.
`pre`	This adds a prefix to the first and second numbers.
`pre1`	This adds a prefix to the first number.
`pre2`	This adds a prefix to the second number.
`suf`	This adds a suffix to the first and second numbers.
`suf1`	This adds a suffix to the first number.
`suf2`	This adds a suffix to the second number.
`sort`	This adds or removes the {{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).
`italics`	This can either have the value of `on` or `off`. `italics=on` makes the output italic. The default is `italics=off`.
`bold`	This can either have the value of `on` or `off`. `bolds=on` makes the output bold. The default is `bold=off`.
`invert`	This can either have the value of `on` or `off`. `invert=on` switches the base and object values in the calculation of percentage change. The default is `invert=off`.
`align`	This adjusts the alignment of text in cells. `align=center` and `align=left` aligns the text to the centre and left respectively. The default is `align=right`.
`rowspan`	This adjust the row span of cells. The default is `rowspan=1`.
`bgcolour`	This adjusts the background colour of cells. The default is `bgcolour=#F9F9F9` (light grey).
`disp`	This controls what is output. `disp=out` produces the percentage change only (and thus `align`, `rowspan` and `bgcolour` do not work with `disp=out`). The default is `disp=row` which produces three cells in a table row.

The following sortable tables illustrate the use of this template.

Wiki markup Tables

{|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= 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}}
|-
|}

Without extra code

Region	first	second	change
Big Meadow	1,830,000	1,900,679.75	+3.86%
Little Meadow	400,000	500,000	+25.00%
Mount Acme	2,450,000	2,205,678.37	−9.97%
Acmevale North	1,250,000	1,000,000	−20.00%
Acmevale South	1,250,000	1,000,000	−20.00%
Homeport	5,120,000	5,589,462.6	+9%
Longwood	930,000	930,027.92	+0.003%
Meadowbrook	$2,450,000	$2,450,000	0.00%
Johnstown	3,400,000 kg	3,902,340.05 kg	+14.77%
Lakewood	2,250,000	2,236,005.56	−0.62%
Fox Hollow	1,180,000	1,190,345.32	+0.88%
Riverton	10,550,000	11,236,005.55	+6.50%
Timber Creek	1,360,000	1,310,948.3	−3.61%
Terminated	1,500	0	−100.00%
Upstart	0	26,250.5	NA

With |disp=out

Region	change
Big Meadow	+3.86%
Little Meadow	+25.00%
Mount Acme	−9.97%
Acmevale North	−20.00%
Acmevale South
Homeport	+9%
Longwood	+0.003%
Meadowbrook	0.00%
Johnstown	+14.77%
Lakewood	−0.62%
Fox Hollow	+0.88%
Riverton	+6.50%
Timber Creek	−3.61%
Terminated	−100.00%
Upstart	NA

With |invert=on

Region	first	second	change
Big Meadow	1,830,000	1,900,679.75	−3.72%
Little Meadow	400,000	500,000	−20.00%
Mount Acme	2,450,000	2,205,678.37	+11.08%
Acmevale North	1,250,000	1,000,000	+25.00%
Acmevale South	1,250,000	1,000,000	+25.00%
Homeport	5,120,000	5,589,462.6	−8%
Longwood	930,000	930,027.92	−0.003%
Meadowbrook	$2,450,000	$2,450,000	0.00%
Johnstown	3,400,000 kg	3,902,340.05 kg	−12.87%
Lakewood	2,250,000	2,236,005.56	+0.63%
Fox Hollow	1,180,000	1,190,345.32	−0.87%
Riverton	10,550,000	11,236,005.55	−6.11%
Timber Creek	1,360,000	1,310,948.3	+3.74%
Terminated	1,500	0	NA
Upstart	0	26,250.5	−100.00%

With |invert=on and |disp=out

Region	change
Big Meadow	−3.72%
Little Meadow	−20.00%
Mount Acme	+11.08%
Acmevale North	+25.00%
Acmevale South
Homeport	−8%
Longwood	−0.003%
Meadowbrook	0.00%
Johnstown	−12.87%
Lakewood	+0.63%
Fox Hollow	−0.87%
Riverton	−6.11%
Timber Creek	+3.74%
Terminated	NA
Upstart	−100.00%

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

Template:Change/doc

Use

Content Disclaimer