Difference between revisions of "Template:Fluctuation formatter/doc"
imported>JohnFromPinckney (Expanded the explanation with a generic use case and some basic examples in prose. Moved the basic "minimize" samples up to nearer the "maximize" samples, to allow easier comparison.) |
imported>Sdkb (It's more the subject that seeks an increased/decreased value than the user; ce) |
||
| Line 2: | Line 2: | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | <!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | ||
== Usage == | == Usage == | ||
| − | Takes a value and displays an {{tl|increase}}, {{tl|decrease}}, or {{tl|steady}} symbol with the value based | + | Takes a value and displays an {{tl|increase}}, {{tl|decrease}}, or {{tl|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 '''{{tl|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 <code>Value</code> with a <code>Type</code> of "maximize" (the default) will show the green upward arrow of {{tl|increase}}, as that type assumes the | + | For example, a positive <code>Value</code> with a <code>Type</code> of "maximize" (the default) will show the green upward arrow of {{tl|increase}}, as that type assumes the goal is for the value to be maximized. Likewise, a negative <code>Value</code> with a <code>Type</code> of "maximize" produces the red downward arrow of {{tl|decrease}}. |
| − | Inversely, a positive <code>Value</code> with a <code>Type</code> of "minimize" will show the red downward arrow of {{tl|decrease}}, as that type assumes the | + | Inversely, a positive <code>Value</code> with a <code>Type</code> of "minimize" will show the red downward arrow of {{tl|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 <code>Value</code> with a <code>Type</code> of "minimize" produces the green upward arrow of {{tl|increase}}, since a minimized value is sought and the value has moved in that direction. |
==Examples== | ==Examples== | ||
Latest revision as of 02:13, 20 September 2020
| This is a documentation subpage for Template:Fluctuation formatter. It contains usage information, categories and other content that is not part of the original template page. |
Contents
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 Value with a Type 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 Value with a Type of "maximize" produces the red downward arrow of {{decrease}}.
Inversely, a positive Value with a Type 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 Value with a Type of "minimize" produces the green upward arrow of {{increase}}, since a minimized value is sought and the value has moved in that direction.
Examples
{{fluc|47}}or{{fluc|47|maximize}}produces
+47{{fluc|-47}}or{{fluc|-47|maximize}}produces
−47{{fluc|47|minimize}}produces
+47{{fluc|-47|minimize}}produces
−47{{fluc|0}}produces Template:Steady no change{{fluc|-47|threshold=100}}produces Template:Steady −47{{fluc|0|steady label=unchanged}}produces Template:Steady unchanged{{fluc|47|neutral}}produces
+47{{fluc|-1000|custom label=$47 million}}produces
$47 million{{fluc|-1000|custom label=}}produces
(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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Value | 1 | The value being fed to the template
| Number | required |
| Type | 2 type | The type of value being fed to the template, which affects the arrow color. Use "maximize", "minimize", or "neutral".
| Unknown | optional |
| Steady label | steady label | Specifies custom text to use alongside a steady result
| String | optional |
| Custom label | custom label | Specifies a custom value to display instead of the one being fed into the template | String | optional |
| Threshold | threshold | Specifies the maximum deviation from zero for which a steady symbol will display
| Number | optional |
See also
- Template:Tfluc-common-doc, the common documentation for the fluctuation icons