imported>Thingofme: high-use

2023-01-10T02:52:27Z

high-use

New page

{{Documentation subpage}}
{{high-use}}
{{tsh|pct|percent}}
{{lua|Module:Percentage}}

==Usage==
{{mono|<nowiki>{{percentage | numerator | denominator | decimals to round to (zero or greater) }}</nowiki>}}

==Limitations==
Figures smaller than 0.0001% are shown in scientific notation.

==Examples==
* <nowiki>{{Percentage | 1 | 3 | 0 }}</nowiki> yields {{Percentage | 1 | 3 | 0 }}
* <nowiki>{{Percentage | 1 | 3 | 2 }}</nowiki> yields {{Percentage | 1 | 3 | 2 }}

Negative values can be used:
* <nowiki>{{Percentage | -1 | 3 }}</nowiki> yields {{Percentage | -1 | 3 }}

Normal operation is to cut off all decimal zeroes from right in rounding:
* <nowiki>{{Percentage | 1 | 5 | 2 }}</nowiki> yields {{Percentage | 1 | 5 | 2 }}
* <nowiki>{{Percentage | 1111 | 10000 | 4 }}</nowiki> yields {{Percentage | 1111 | 10000 | 4 }}
Add '''{{mono|<nowiki>|pad=yes</nowiki>}}''' to always get as many decimals as specified, padding with zeroes where needed:
* <nowiki>{{Percentage | 1 | 5 | 2 | pad=yes }}</nowiki> yields {{Percentage | 1 | 5 | 2 | pad=yes }}
* <nowiki>{{Percentage | 1111 | 10000 | 4 | pad=yes }}</nowiki> yields {{Percentage | 1111 | 10000 | 4 | pad=yes }}
Third parameter can also be given through {{mono|<nowiki>|pad=N</nowiki>}}:
* <nowiki>{{Percentage | 111 | 1000 | pad=4 }}</nowiki> is same as <nowiki>{{Percentage | 111 | 1000 | 4 | pad=yes }}</nowiki> and yields {{Percentage | 111 | 1000 | pad=4 }}

Default denominator is 100:
* <nowiki>{{Percentage | 20 }}</nowiki> yields {{Percentage | 20 }}

Default precision is zero:
* <nowiki>{{Percentage | 1 | 3 }}</nowiki> yields {{Percentage | 1 | 3 }}

Override the percent symbol
* <nowiki>{{Percentage | 1 | 3 | % = &nbsp;percent}}</nowiki> yields {{Percentage | 1 | 3 | % =  percent}}

Use a prescribed number of significant figures
* <nowiki>{{Percentage | 1 | 4000 | sigfig = 3}}</nowiki> yields {{Percentage | 1 | 4000 | sigfig = 3}}

Use a prescribed number of significant figures with small percentages
* <nowiki>{{Percentage | 1 | 40000000 | sigfig = 3}}</nowiki> yields {{Percentage | 1 | 40000000 | sigfig = 3}}

Use a prescribed number of significant figures with small percentages without scientific notation
* <nowiki>{{Percentage | 1 | 40000000 | sigfig = 3 | nonscinote = y}}</nowiki> yields {{Percentage | 1 | 40000000 | sigfig = 3 | nonscinote = y }}

Use a prescribed number of significant figures with large percentages
* <nowiki>{{Percentage | 40000000 | 2 | sigfig = 3}}</nowiki> yields {{Percentage | 40000000 | 2 | sigfig = 3}}

Use a prescribed number of significant figures with large percentages without scientific notation
* <nowiki>{{Percentage | 40000000 | 2 | sigfig = 3 | nonscinote = y}}</nowiki> yields {{Percentage | 40000000 | 2 | sigfig = 3 | nonscinote = y }}

Dividing by zero will result in "nan" ([[division by zero|undefined]])
* <nowiki>{{Percentage | 0 | 0 | 0 }}</nowiki> yields {{Percentage | 0 | 0 | 0 }}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Numerator",
"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",
"required": true
},
"2": {
"label": "Denominator",
"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",
"suggested": true,
"default": "100"
},
"3": {
"label": "Decimals",
"description": "Number of decimals to round to (zero or greater); if pad is not Yes, 0-digits will be cropped from the end.",
"type": "number",
"default": "0"
},
"pad": {
"label": "Pad / actual number of digits",
"description": "If yes, use all digits given in Decimals. If a number, pad to that number of decimals.",
"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"
},
"%": {
"description": "Replacement for % symbol",
"example": " percent",
"type": "string",
"label": "% replacement"
}
},
"description": "Calculates and displays a percentage value."
}
</templatedata>

== See also ==
* {{tl|Number and percent}}
* {{tl|Winning percentage}}
* {{tl|Round}}
* {{tl|Significant figures}}
* {{tl|Fractions and ratios}}
<includeonly>{{basepage subpage|
[[Category:Mathematical function templates|Percentage]]
}}</includeonly>

Template:Percentage/doc - Revision history

imported>Thingofme: high-use