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

From blackwiki
Jump to navigation Jump to search
imported>Sdkb
(adding category)
imported>Sdkb
(see also)
Line 53: Line 53:
 
}
 
}
 
</templatedata>
 
</templatedata>
 +
 +
==See also==
 +
*[[Template:Tfluc-common-doc]], the common documentation for the fluctuation icons

Revision as of 05:07, 16 August 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

  • {{fluc|47}} or {{fluc|47|maximize}} produces Increase +47
  • {{fluc|-47}} or {{fluc|-47|maximize}} produces Decrease −47
  • {{fluc|0}} produces Template:Steady no change
  • {{fluc|0|steady label=unchanged}} produces Template:Steady unchanged
  • {{fluc|47|minimize}} produces Negative increase +47
  • {{fluc|47|neutral}} produces Neutral increase +47
  • {{fluc|-1000|custom label=$47 million}} produces Decrease $47 million
  • {{fluc|-1000|custom label=}} produces Decrease  (note: still includes the non-breaking space)

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. 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

See also