Template:IncreaseNeutral/doc
 | This is a documentation subpage for Template:IncreaseNeutral. It may contain usage information, categories and other content that is not part of the original template page. |
Icons to show fluctuation
[edit]This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:IncreaseNeutral in articles based on its TemplateData.
TemplateData for IncreaseNeutral
This is one of a series of templates to display an increase or decrease arrow icon. 
{{Increase}} = {{IncreasePositive}} = {{Up}} = {{Gain}} = {{Profit}} is a green up arrow. 
{{Decrease}} = {{DecreaseNegative}} = {{Down}} = {{Loss}} is a red down arrow. 
{{Steady}} = {{Nochange}} = {{Same}} is a flat line for no change. Examples of situations where the use of {{Increase}} is appropriate include: (a) the quantity involved should be minimized (e.g. a country's HDI rank), is always non-negative by definition and has encouragingly improved, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, is currently a positive number (indicating a profit, justifying the green color) and has thankfully improved (a profit which follows either a loss or a lower profit, justifying the up arrow). Examples of situations where the use of {{Decrease}} is appropriate include: (a) the quantity involved should be minimized (e.g. a country's HDI rank), is always non-negative by definition and has unfortunately worsened, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, and has undesirably deteriorated (reduced income—resulting from a reduced profit or an increased loss or a loss following a profit—justifying the red color and the down arrow), (c) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition, is currently a positive number (indicating net positive emission, justifying the red color) and has encouragingly fallen (reduction in net carbon emission, justifying the down arrow).
Use
{{IncreaseNegative}} or 
{{DecreasePositive}} to flip the color. Examples of situations where the use of {{IncreaseNegative}} is appropriate include: (a) the quantity involved should be minimized (e.g. road accidents), is always non-negative by definition and has unfortunately risen, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, is currently a negative number (indicating a loss, i.e., a negative income, justifying the red color) and has encouragingly improved (reduction in loss, i.e., rise in income, justifying the up arrow), (c) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition and has undesirably increased (rise in net carbon emission, justifying the up red arrow). Examples of situations where the use of {{DecreasePositive}} is appropriate include: (a) the quantity involved should be minimized (e.g. road accidents), is always non-negative by definition and has thankfully fallen, and (b) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition, is currently a negative number (indicating net negative emission, justifying the green color) and has encouragingly fallen (reduction in net carbon emission, justifying the down arrow).
Where the quantity involved is neither color, use
{{IncreaseNeutral}} and 
{{DecreaseNeutral}}.
To automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.
{{Increase}} = {{IncreasePositive}} = {{Up}} = {{Gain}} = {{Profit}} is a green up arrow. 
{{Decrease}} = {{DecreaseNegative}} = {{Down}} = {{Loss}} is a red down arrow. 
{{Steady}} = {{Nochange}} = {{Same}} is a flat line for no change. Examples of situations where the use of {{Increase}} is appropriate include: (a) the quantity involved should be minimized (e.g. a country's HDI rank), is always non-negative by definition and has encouragingly improved, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, is currently a positive number (indicating a profit, justifying the green color) and has thankfully improved (a profit which follows either a loss or a lower profit, justifying the up arrow). Examples of situations where the use of {{Decrease}} is appropriate include: (a) the quantity involved should be minimized (e.g. a country's HDI rank), is always non-negative by definition and has unfortunately worsened, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, and has undesirably deteriorated (reduced income—resulting from a reduced profit or an increased loss or a loss following a profit—justifying the red color and the down arrow), (c) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition, is currently a positive number (indicating net positive emission, justifying the red color) and has encouragingly fallen (reduction in net carbon emission, justifying the down arrow).Use
{{IncreaseNegative}} or 
{{DecreasePositive}} to flip the color. Examples of situations where the use of {{IncreaseNegative}} is appropriate include: (a) the quantity involved should be minimized (e.g. road accidents), is always non-negative by definition and has unfortunately risen, and (b) the quantity involved should be maximized (e.g. annual income for a business), may generally be positive, negative or zero by definition, is currently a negative number (indicating a loss, i.e., a negative income, justifying the red color) and has encouragingly improved (reduction in loss, i.e., rise in income, justifying the up arrow), (c) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition and has undesirably increased (rise in net carbon emission, justifying the up red arrow). Examples of situations where the use of {{DecreasePositive}} is appropriate include: (a) the quantity involved should be minimized (e.g. road accidents), is always non-negative by definition and has thankfully fallen, and (b) the quantity involved should be minimized (e.g. a country's net carbon emission), may generally be positive, negative or zero by definition, is currently a negative number (indicating net negative emission, justifying the green color) and has encouragingly fallen (reduction in net carbon emission, justifying the down arrow).Where the quantity involved is neither color, use
{{IncreaseNeutral}} and 
{{DecreaseNeutral}}.To automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Tooltip text | 1 | Changes the text displayed on hover.
| String | optional |
| size | size | Changes the size of the icon. Use when adjacent to small/large text.
| Unknown | optional |
See also
[edit]