Template:Change/doc

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.
suf	This adds a suffix to the first and second numbers.
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 7000386228142076500♠+3.86% Little Meadow 400,000 500,000 7001250000000000000♠+25.00% Mount Acme 2,450,000 2,205,678.37 2999002768857142859♠−9.97% Acmevale North 1,250,000 1,000,000 2998800000000000000♠−20.00% Acmevale South Homeport 5,120,000 5,589,462.60 7000916919140625000♠+9% Longwood 930,000 930,027.92 6997300215053763430♠+0.003% Meadowbrook 7006245000000000000♠$2,450,000 7006245000000000000♠$2,450,000.00 50000000000000000000.00% Johnstown 7006340000000000000♠3,400,000 kg 7006390234005000000♠3,902,340.05 kg 7001147747073529410♠+14.77% Lakewood 2,250,000 2,236,005.56 3000378024888888889♠−0.62% Fox Hollow 1,180,000 1,190,345.32 6999876722033898300♠+0.88% Riverton 10,550,000 11,236,005.55 7000650242227488150♠+6.50% Timber Creek 1,360,000 1,310,948.30 2999639325735294120♠−3.61% Terminated 1,500 0.00 2997900000000000000♠−100.00% Upstart 0 26,250.50 0000000000000000000NA		With |disp=out Region change Big Meadow 7000386228142076500♠+3.86% Little Meadow 7001250000000000000♠+25.00% Mount Acme 2999002768857142859♠−9.97% Acmevale North 2998800000000000000♠−20.00% Acmevale South Homeport 7000916919140625000♠+9% Longwood 6997300215053763430♠+0.003% Meadowbrook 50000000000000000000.00% Johnstown 7001147747073529410♠+14.77% Lakewood 3000378024888888889♠−0.62% Fox Hollow 6999876722033898300♠+0.88% Riverton 7000650242227488150♠+6.50% Timber Creek 2999639325735294120♠−3.61% Terminated 2997900000000000000♠−100.00% Upstart 0000000000000000000NA
			With |invert=on Region first second change Big Meadow 1,830,000 1,900,679.75 2999628134355616720♠−3.72% Little Meadow 400,000 500,000 2998800000000000000♠−20.00% Mount Acme 2,450,000 2,205,678.37 7001110769382029170♠+11.08% Acmevale North 1,250,000 1,000,000 7001250000000000000♠+25.00% Acmevale South Homeport 5,120,000 5,589,462.60 2999160093494498019♠−8% Longwood 930,000 930,027.92 3002699793958873870♠−0.003% Meadowbrook 7006245000000000000♠$2,450,000 7006245000000000000♠$2,450,000.00 50000000000000000000.00% Johnstown 7006340000000000000♠3,400,000 kg 7006390234005000000♠3,902,340.05 kg 2998871272097366299♠−12.87% Lakewood 2,250,000 2,236,005.56 6999625867853387630♠+0.63% Fox Hollow 1,180,000 1,190,345.32 3000130897578527879♠−0.87% Riverton 10,550,000 11,236,005.55 2999389457804246100♠−6.11% Timber Creek 1,360,000 1,310,948.30 7000374169599213030♠+3.74% Terminated 1,500 0.00 0000000000000000000NA Upstart 0 26,250.50 2997900000000000000♠−100.00%		With |invert=on and |disp=out Region change Big Meadow 2999628134355616720♠−3.72% Little Meadow 2998800000000000000♠−20.00% Mount Acme 7001110769382029170♠+11.08% Acmevale North 7001250000000000000♠+25.00% Acmevale South Homeport 2999160093494498019♠−8% Longwood 3002699793958873870♠−0.003% Meadowbrook 50000000000000000000.00% Johnstown 2998871272097366299♠−12.87% Lakewood 6999625867853387630♠+0.63% Fox Hollow 3000130897578527879♠−0.87% Riverton 2999389457804246100♠−6.11% Timber Creek 7000374169599213030♠+3.74% Terminated 0000000000000000000NA Upstart 2997900000000000000♠−100.00%

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