Template:Increase

File:Test Template Info-Icon - Version (2).svg Template documentation[view] [edit] [history] [purge]

Icons to show fluctuation

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Increase in articles based on its TemplateData.

TemplateData for Increase

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 {{Steady}} = {{Nochange}} = {{Same}} is a flat line for no change. Examples of situations where the use of  {{Increase}} is appropriate include:

1. The quantity involved is an entity's rank according to a property where minimizing the quantity is desirable (e.g., a country's HDI rank), is always non-negative by definition and shows an encouraging improvement (e.g., an improvement in a country’s HDI rank).
2. The quantity involved should be maximized (e.g., global literacy rate, annual revenue for a business, log probability for a likelihood function in maximum likelihood estimation), can take values from either the set of non-negative reals or the set of non-positive reals (but not both), and implies a favorable progression (e.g., an increased literacy rate, an increased revenue, a higher log probability).
3. The quantity involved should be maximized (e.g., annual income for a business), may be positive, negative or zero in general, is currently a positive number (e.g., a profit, i.e., a positive annual income, justifying the green color) and informs a constructive shift (e.g., 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:

1. The quantity involved is an entity's rank according to a property where minimizing the quantity is desirable (e.g., a country's HDI rank), is always non-negative by definition and shows an undesirable shift (e.g., a worsening in a country’s HDI rank).
2. The quantity involved should be maximized (e.g., global literacy rate, annual revenue or income for a business, log probability for a likelihood function in maximum likelihood estimation) and implies an unwanted deterioration (e.g., a reduction in literacy rate, a fall in revenue, a decrease in income—resulting from a reduced profit or an increased loss or a loss following a profit, a reduction in log probability).
3. The quantity involved should be minimized (e.g., a country's net carbon emission), may be positive, negative or zero in general, is currently a positive number (e.g., a net positive emission which is undesirable, justifying the red color) and informs a promising enhancement (e.g., a reduction in net carbon emission, justifying the down arrow).

Use Negative increase {{IncreaseNegative}} or Positive decrease {{DecreasePositive}} to flip the color. Examples of situations where the use of Negative increase {{IncreaseNegative}} is appropriate include:

1. The quantity involved should be minimized (e.g., road accidents, a country's net carbon emission), is not an entity's rank according to a property where minimizing the quantity is desirable, and shows an unfortunate worsening (e.g., a rise in road accidents, a rise in a country's net carbon emission).
2. The quantity involved should be maximized (e.g., annual income for a business), may be positive, negative or zero in general, is currently a negative number (e.g., a loss, i.e., a negative income, justifying the red color) and implies an encouraging improvement (e.g., a reduction in loss, i.e., a rise in income, justifying the up arrow).

Examples of situations where the use of Positive decrease {{DecreasePositive}} is appropriate include:

1. The quantity involved should be minimized (e.g., road accidents), is not an entity's rank according to a property where minimizing the quantity is desirable, can take values from either the set of non-negative reals or the set of non-positive reals (but not both), and communicates a favorable progression (e.g., a reduction in road accidents).
2. The quantity involved should be minimized (e.g., a country's net carbon emission), may be positive, negative or zero in general, is currently a negative number (e.g., a net negative emission, justifying the green color) and informs a desired enhancement (e.g., a reduction in net carbon emission, justifying the down arrow).

Where using neither color is preferred, use Neutral increase {{IncreaseNeutral}} and Neutral decrease {{DecreaseNeutral}}.

To automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.

⧼templatedata-doc-param-name⧽		⧼templatedata-doc-param-desc⧽	⧼templatedata-doc-param-type⧽	⧼templatedata-doc-param-status⧽
Tooltip text	1	Changes the text displayed on hover. ⧼templatedata-doc-param-default⧽ Defaults to something appropriate to the chosen template, such as "Increase". ⧼templatedata-doc-param-example⧽ −5%	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-optional⧽
size	size	Changes the size of the icon. Use when adjacent to small/large text. ⧼templatedata-doc-param-default⧽ 11px	⧼templatedata-doc-param-type-unknown⧽	⧼templatedata-doc-param-status-optional⧽

Format: inline

<templatedata>{"format":"inline","description":"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: The quantity involved is an entity's rank according to a property where minimizing the quantity is desirable (e.g., a country's HDI rank), is always non-negative by definition and shows an encouraging improvement (e.g., an improvement in a country’s HDI rank).The quantity involved should be maximized (e.g., global literacy rate, annual revenue for a business, log probability for a likelihood function in maximum likelihood estimation), can take values from either the set of non-negative reals or the set of non-positive reals (but not both), and implies a favorable progression (e.g., an increased literacy rate, an increased revenue, a higher log probability).The quantity involved should be maximized (e.g., annual income for a business), may be positive, negative or zero in general, is currently a positive number (e.g., a profit, i.e., a positive annual income, justifying the green color) and informs a constructive shift (e.g., 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: The quantity involved is an entity's rank according to a property where minimizing the quantity is desirable (e.g., a country's HDI rank), is always non-negative by definition and shows an undesirable shift (e.g., a worsening in a country’s HDI rank).The quantity involved should be maximized (e.g., global literacy rate, annual revenue or income for a business, log probability for a likelihood function in maximum likelihood estimation) and implies an unwanted deterioration (e.g., a reduction in literacy rate, a fall in revenue, a decrease in income—resulting from a reduced profit or an increased loss or a loss following a profit, a reduction in log probability).The quantity involved should be minimized (e.g., a country's net carbon emission), may be positive, negative or zero in general, is currently a positive number (e.g., a net positive emission which is undesirable, justifying the red color) and informs a promising enhancement (e.g., a 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:The quantity involved should be minimized (e.g., road accidents, a country's net carbon emission), is not an entity's rank according to a property where minimizing the quantity is desirable, and shows an unfortunate worsening (e.g., a rise in road accidents, a rise in a country's net carbon emission).The quantity involved should be maximized (e.g., annual income for a business), may be positive, negative or zero in general, is currently a negative number (e.g., a loss, i.e., a negative income, justifying the red color) and implies an encouraging improvement (e.g., a reduction in loss, i.e., a rise in income, justifying the up arrow). Examples of situations where the use of {{DecreasePositive}} is appropriate include:The quantity involved should be minimized (e.g., road accidents), is not an entity's rank according to a property where minimizing the quantity is desirable, can take values from either the set of non-negative reals or the set of non-positive reals (but not both), and communicates a favorable progression (e.g., a reduction in road accidents).The quantity involved should be minimized (e.g., a country's net carbon emission), may be positive, negative or zero in general, is currently a negative number (e.g., a net negative emission, justifying the green color) and informs a desired enhancement (e.g., a reduction in net carbon emission, justifying the down arrow).Where using neither color is preferred, use {{IncreaseNeutral}} and {{DecreaseNeutral}}.\r\n\r\nTo automatically display the appropriate symbol along with a value, use {{Fluctuation formatter}}.","paramOrder":["1","size"],

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

See also

• Template:Fluctuation formatter

The above documentation is transcluded from Template:Increase/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Add categories to the /doc subpage. Subpages of this template.