Difference between revisions of "Template:Fluctuation formatter/doc"

From blackwiki
Jump to navigation Jump to search
imported>Mattbuck
m (→‎Examples: for clarity)
imported>Sdkb
(→‎TemplateData: Clarify)
Line 35: Line 35:
 
"2": {
 
"2": {
 
"label": "Type",
 
"label": "Type",
"description": "The type of value being fed to the template. Use \"maximize\", \"minimize\", or \"neutral\".",
+
"description": "The type of value being fed to the template, which affects the arrow color. Use \"maximize\", \"minimize\", or \"neutral\".",
 
"default": "Maximize",
 
"default": "Maximize",
 
"aliases": [
 
"aliases": [

Revision as of 06:37, 14 September 2020

Usage

Takes a value and displays an {{increase}}, {{decrease}}, or {{steady}} symbol with the value based 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}}.

Examples

TemplateData

Takes a value and displays an increase, decrease, or steady symbol based on whether the value is positive, negative, or zero.

Template parameters

ParameterDescriptionTypeStatus
Value1

The value being fed to the template

Example
-47
Numberrequired
Type2 type

The type of value being fed to the template, which affects the arrow color. Use "maximize", "minimize", or "neutral".

Default
Maximize
Unknownoptional
Steady labelsteady label

Specifies custom text to use alongside a steady result

Default
no change
Example
unchanged
Stringoptional
Custom labelcustom label

Specifies a custom value to display instead of the one being fed into the template

Stringoptional
Thresholdthreshold

Specifies the maximum deviation from zero for which a steady symbol will display

Default
0
Numberoptional

See also