Osarius: 1 revision imported

2024-09-22T09:07:58Z

1 revision imported

← Older revision	Revision as of 09:07, 22 September 2024
(No difference)

wikipedia>Cedar101: syntaxhighlight, {{tlx}}, {{para}}

2024-03-06T01:12:45Z

syntaxhighlight, {{tlx}}, {{para}}

New page

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

==Usage==
{{tlx|percentage | numerator | denominator | decimals to round to (zero or greater) }}

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

==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:
* <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 '''{{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 {{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:
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 20 }}</syntaxhighlight> yields {{Percentage | 20 }}

Default precision is zero:
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 }}</syntaxhighlight> yields {{Percentage | 1 | 3 }}

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
* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 4000 | sigfig = 3}}</syntaxhighlight> yields {{Percentage | 1 | 4000 | sigfig = 3}}

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

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

Osarius: 1 revision imported

wikipedia>Cedar101: syntaxhighlight, {{tlx}}, {{para}}