Template:Fluctuation formatter/doc

Usage
Takes a value and displays an increase, decrease, or steady symbol with the value based (by default) on whether it is positive, negative, or zero. The type of value can be specified using the second parameter as "maximize", "minimize", or "neutral". Can be called using the shortcut Fluc. It's meant to be used to show a fluctuation snapshot, where the provided value indicates a move up (positive) or down (negative), or possibly held steady (zero = no change) in relationship to some earlier measurement.

For example, a positive  with a   of "maximize" (the default) will show the green upward arrow of increase, as that type assumes the goal is for the value to be maximized. Likewise, a negative  with a   of "maximize" produces the red downward arrow of decrease.

Inversely, a positive  with a   of "minimize" will show the red downward arrow of decrease, as that type assumes the goal is for the value to be minimized, but as a positive number, it's gone the wrong direction. Likewise, a negative  with a   of "minimize" produces the green upward arrow of increase, since a minimized value is sought and the value has moved in that direction.

Examples

 * or produces  +47
 * or produces  -47
 * produces +47
 * produces -47
 * produces +47
 * produces -47
 * produces no change
 * produces -47
 * produces no change
 * produces $47 million
 * produces -1000 (note: still includes the non-breaking space)

TemplateData
{	"params": { "1": {			"label": "Value", "description": "The value being fed to the template", "example": "-47", "type": "number", "required": true },		"2": {			"label": "Type", "description": "The type of value being fed to the template, which affects the arrow color. Use \"maximize\", \"minimize\", or \"neutral\".", "default": "Maximize", "aliases": [ "type" ]		},		"steady label": { "description": "Specifies custom text to use alongside a steady result", "example": "unchanged", "default": "no change", "type": "string" },		"custom label": { "description": "Specifies a custom value to display instead of the one being fed into the template", "type": "string" },		"threshold": { "description": "Specifies the maximum deviation from zero for which a steady symbol will display", "type": "number", "default": "0" }	},	"description": "Takes a value and displays an increase, decrease, or steady symbol based on whether the value is positive, negative, or zero." }