Template:Tfluc-common-doc

From ModelUSGov Wiki
Jump to navigation Jump to search

Icons to show fluctuation[edit source]

This templatedata is intended to be generic and apply to all the templates mentioned.

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Tfluc-common-doc

This is one of a series of templates to display an increase or decrease arrow icon. Increase {{Increase}} = {{IncreasePositive}} = {{Gain}} = {{Profit}} is a green up arrow. Decrease {{Decrease}} = {{DecreaseNegative}} = {{Down}} = {{Loss}} is a red down arrow. Steady {{Steady}} = {{Nochange}} is a flat line for no change. Where the quantity involved should be minimized (e.g. road accidents), use Negative increase {{IncreaseNegative}} and Positive decrease {{DecreasePositive}} instead, which flip the colors. Where the quantity involved is neither color, use Neutral increase {{IncreaseNeutral}} and Neutral decrease {{DecreaseNeutral}}.

To automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.
ParameterDescriptionTypeStatus
Tooltip text1
Changes the text displayed on hover.
Default
Defaults to something appropriate to the chosen template, such as "Increase".
Example
−5%
Stringoptional
sizesize
Changes the size of the icon. Use when adjacent to small/large text.
Default
11px
Unknownoptional

Format: inline

Test of raw TemplateData output:
<templatedata>{"description":"This is one of a series of templates to display an increase or decrease arrow icon. {{Increase}} = {{IncreasePositive}} = {{Gain}} = {{Profit}} is a green up arrow. {{Decrease}} = {{DecreaseNegative}} = {{Down}} = {{Loss}} is a red down arrow. {{Steady}} = {{Nochange}} is a flat line for no change. Where the quantity involved should be minimized (e.g. road accidents), use {{IncreaseNegative}} and {{DecreasePositive}} instead, which flip the colors. Where the quantity involved is neither color, use {{IncreaseNeutral}} and {{DecreaseNeutral}}., , To automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.","format":"inline",

"params":{ "1":{"type":"string","description":"Changes the text displayed on hover.","label":"Tooltip text","example":"−5%","default":"Defaults to something appropriate to the chosen template, such as \"Increase\"."},

"size":{"type":"unknown","description":"Changes the size of the icon. Use when adjacent to small/large text.","default":"11px"} }

}</templatedata>