Template:Percentage/doc: Difference between revisions
Improved TemplateData a bit. |
m syntaxhighlight, {{tlx}}, {{para}} |
||
(20 intermediate revisions by 10 users not shown) | |||
Line 1: | Line 1: | ||
{{Documentation subpage}} |
{{Documentation subpage}} |
||
{{high-use}} |
|||
{{tsh|pct|percent}} |
|||
{{lua|Module:Percentage}} |
|||
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. --> |
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. --> |
||
==Usage== |
==Usage== |
||
{{tlx|percentage | numerator | denominator | decimals to round to (zero or greater) }} |
|||
==Limitations== |
|||
Figures smaller than 0.0001% are shown in scientific notation. |
|||
==Examples== |
==Examples== |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 | 0 }}</syntaxhighlight> yields {{Percentage | 1 | 3 | 0 }} |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 | 2 }}</syntaxhighlight> yields {{Percentage | 1 | 3 | 2 }} |
||
Negative values can be used: |
Negative values can be used: |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | -1 | 3 }}</syntaxhighlight> yields {{Percentage | -1 | 3 }} |
||
Normal operation is to cut off all decimal zeroes from right in rounding: |
|||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 5 | 2 }}</syntaxhighlight> yields {{Percentage | 1 | 5 | 2 }} |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1111 | 10000 | 4 }}</syntaxhighlight> yields {{Percentage | 1111 | 10000 | 4 }} |
||
Add ''' |
Add '''{{para|pad|yes}}''' to always get as many decimals as specified, padding with zeroes where needed: |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 5 | 2 | pad=yes }}</syntaxhighlight> yields {{Percentage | 1 | 5 | 2 | pad=yes }} |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1111 | 10000 | 4 | pad=yes }}</syntaxhighlight> yields {{Percentage | 1111 | 10000 | 4 | pad=yes }} |
||
Third parameter can also be given through |
Third parameter can also be given through {{para|pad|N}}: |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 111 | 1000 | pad=4 }}</syntaxhighlight> is same as <syntaxhighlight lang="wikitext" inline>{{Percentage | 111 | 1000 | 4 | pad=yes }}</syntaxhighlight> and yields {{Percentage | 111 | 1000 | pad=4 }} |
||
Default denominator is 100: |
Default denominator is 100: |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 20 }}</syntaxhighlight> yields {{Percentage | 20 }} |
||
Default precision is zero: |
Default precision is zero: |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 }}</syntaxhighlight> yields {{Percentage | 1 | 3 }} |
||
Override the percent symbol |
Override the percent symbol |
||
* < |
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 | % = percent}}</syntaxhighlight> yields {{Percentage | 1 | 3 | % = percent}} |
||
Use a prescribed number of significant figures |
|||
==Aliases== |
|||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 4000 | sigfig = 3}}</syntaxhighlight> yields {{Percentage | 1 | 4000 | sigfig = 3}} |
|||
* <nowiki>{{pct}}</nowiki> |
|||
* <nowiki>{{percent}}</nowiki> |
|||
Use a prescribed number of significant figures with small percentages |
|||
⚫ | |||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 40000000 | sigfig = 3}}</syntaxhighlight> yields {{Percentage | 1 | 40000000 | sigfig = 3}} |
|||
⚫ | |||
* {{tl|Decimals}} |
|||
⚫ | |||
⚫ | |||
Use a prescribed number of significant figures with small percentages without scientific notation |
|||
⚫ | |||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 40000000 | sigfig = 3 | nonscinote = y}}</syntaxhighlight> yields {{Percentage | 1 | 40000000 | sigfig = 3 | nonscinote = y }} |
|||
⚫ | |||
⚫ | |||
Use a prescribed number of significant figures with large percentages |
|||
⚫ | |||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 40000000 | 2 | sigfig = 3}}</syntaxhighlight> yields {{Percentage | 40000000 | 2 | sigfig = 3}} |
|||
Use a prescribed number of significant figures with large percentages without scientific notation |
|||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 40000000 | 2 | sigfig = 3 | nonscinote = y}}</syntaxhighlight> yields {{Percentage | 40000000 | 2 | sigfig = 3 | nonscinote = y }} |
|||
Dividing by zero will result in "nan" ([[division by zero|undefined]]) |
|||
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 0 | 0 | 0 }}</syntaxhighlight> yields {{Percentage | 0 | 0 | 0 }} |
|||
==TemplateData== |
|||
{{TemplateData header}} |
|||
<templatedata> |
<templatedata> |
||
{ |
{ |
||
Line 48: | Line 60: | ||
"1": { |
"1": { |
||
"label": "Numerator", |
"label": "Numerator", |
||
"description": "The Numerator of the calculated value. The percentage will be calculated as Numerator divided by |
"description": "The Numerator of the calculated value. The percentage will be calculated as Numerator divided by Denominator. Use of comma as a thousands separator is optional.", |
||
"type": "number", |
"type": "number", |
||
"required": true |
"required": true |
||
Line 54: | Line 66: | ||
"2": { |
"2": { |
||
"label": "Denominator", |
"label": "Denominator", |
||
"description": "The |
"description": "The Denominator of the calculated value. The percentage will be calculated as Numerator divided by Denominator. Use of comma as a thousands separator is optional. Can be left out, in which case 100 will be used as the Denominator, and the Numerator will be the direct percentage used.", |
||
"type": "number", |
"type": "number", |
||
"suggested": true, |
"suggested": true, |
||
Line 69: | Line 81: | ||
"description": "If yes, use all digits given in Decimals. If a number, pad to that number of decimals.", |
"description": "If yes, use all digits given in Decimals. If a number, pad to that number of decimals.", |
||
"type": "string" |
"type": "string" |
||
}, |
|||
"sigfig": { |
|||
"label": "Significant figures", |
|||
"description": "If set to a positive integer, the precision of the returned number will be adjusted to match the requested number of significant figures.", |
|||
"type": "number" |
|||
}, |
}, |
||
"%": { |
"%": { |
||
Line 80: | Line 97: | ||
} |
} |
||
</templatedata> |
</templatedata> |
||
⚫ | |||
* {{tl|Number and percent}} |
|||
⚫ | |||
⚫ | |||
* {{tl|Significant figures}} |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ |
Latest revision as of 01:12, 6 March 2024
This is a documentation subpage for Template:Percentage. It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 14,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template uses Lua: |
Usage
[edit]{{percentage|numerator|denominator|decimals to round to (zero or greater)}}
Limitations
[edit]Figures smaller than 0.0001% are shown in scientific notation.
Examples
[edit]{{Percentage | 1 | 3 | 0 }}
yields 33%{{Percentage | 1 | 3 | 2 }}
yields 33.33%
Negative values can be used:
{{Percentage | -1 | 3 }}
yields -33%
Normal operation is to cut off all decimal zeroes from right in rounding:
{{Percentage | 1 | 5 | 2 }}
yields 20%{{Percentage | 1111 | 10000 | 4 }}
yields 11.11%
Add |pad=yes
to always get as many decimals as specified, padding with zeroes where needed:
{{Percentage | 1 | 5 | 2 | pad=yes }}
yields 20.00%{{Percentage | 1111 | 10000 | 4 | pad=yes }}
yields 11.1100%
Third parameter can also be given through |pad=N
:
{{Percentage | 111 | 1000 | pad=4 }}
is same as{{Percentage | 111 | 1000 | 4 | pad=yes }}
and yields 11.1000%
Default denominator is 100:
{{Percentage | 20 }}
yields 20%
Default precision is zero:
{{Percentage | 1 | 3 }}
yields 33%
Override the percent symbol
{{Percentage | 1 | 3 | % = percent}}
yields 33 percent
Use a prescribed number of significant figures
{{Percentage | 1 | 4000 | sigfig = 3}}
yields 0.0250%
Use a prescribed number of significant figures with small percentages
{{Percentage | 1 | 40000000 | sigfig = 3}}
yields 00%
Use a prescribed number of significant figures with small percentages without scientific notation
{{Percentage | 1 | 40000000 | sigfig = 3 | nonscinote = y}}
yields 00%
Use a prescribed number of significant figures with large percentages
{{Percentage | 40000000 | 2 | sigfig = 3}}
yields 2.00×109%
Use a prescribed number of significant figures with large percentages without scientific notation
{{Percentage | 40000000 | 2 | sigfig = 3 | nonscinote = y}}
yields 2000000000%
Dividing by zero will result in "nan" (undefined)
{{Percentage | 0 | 0 | 0 }}
yields nan%
TemplateData
[edit]TemplateData for Percentage
Calculates and displays a percentage value.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Numerator | 1 | The Numerator of the calculated value. The percentage will be calculated as Numerator divided by Denominator. Use of comma as a thousands separator is optional. | Number | required |
Denominator | 2 | The Denominator of the calculated value. The percentage will be calculated as Numerator divided by Denominator. Use of comma as a thousands separator is optional. Can be left out, in which case 100 will be used as the Denominator, and the Numerator will be the direct percentage used.
| Number | suggested |
Decimals | 3 | Number of decimals to round to (zero or greater); if pad is not Yes, 0-digits will be cropped from the end.
| Number | optional |
Pad / actual number of digits | pad | If yes, use all digits given in Decimals. If a number, pad to that number of decimals. | String | optional |
Significant figures | sigfig | If set to a positive integer, the precision of the returned number will be adjusted to match the requested number of significant figures. | Number | optional |
% replacement | % | Replacement for % symbol
| String | optional |
See also
[edit]- {{Number and percent}}
- {{Winning percentage}}
- {{Round}}
- {{Significant figures}}
- {{Fractions and ratios}}