Template:Percentage/doc: Difference between revisions

Content deleted Content added

Inline

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.

Shortcuts

{{pct}}
{{percent}}

This template uses Lua:

Module:Percentage (sandbox)

Usage

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

Limitations

Figures smaller than 0.0001% are shown in scientific notation.

Examples

{{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×10⁹%

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

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

TemplateData for Percentage

Calculates and displays a percentage value.

Template parameters
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. Default 100	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. Default 0	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 Example  percent	String	optional

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
+{{high-use}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE. -->
+{{tsh|pct|percent}}
+{{lua|Module:Percentage}}
+<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->
 ==Usage==
-<tt><nowiki>{{percentage | numerator | denominator | decimals to round to (zero or greater) }}</nowiki></tt>
+{{tlx|percentage | numerator | denominator | decimals to round to (zero or greater) }}
+==Limitations==
+Figures smaller than 0.0001% are shown in scientific notation.
 ==Examples==
-* <nowiki>{{Percentage | 1 | 3 | 0 }}</nowiki> yields {{Percentage | 1 | 3 | 0 }}
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 | 0 }}</syntaxhighlight> yields {{Percentage | 1 | 3 | 0 }}
-* <nowiki>{{Percentage | 1 | 3 | 2 }}</nowiki> yields {{Percentage | 1 | 3 | 2 }}
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 3 | 2 }}</syntaxhighlight> yields {{Percentage | 1 | 3 | 2 }}
+Negative values can be used:
-Nornal operation is to cut off all decimal zeroes from right in rounding:
-* <nowiki>{{Percentage | 1 | 5 | 2 }}</nowiki> yields {{Percentage | 1 | 5 | 2 }}
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | -1 | 3 }}</syntaxhighlight> yields {{Percentage | -1 | 3 }}
-* <nowiki>{{Percentage | 1111 | 10000 | 4 }}</nowiki> yields {{Percentage | 1111 | 10000 | 4 }}
-Add '''<tt>|pad=yes</tt>''' to always get as many deciamls 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 <tt>|pad=N</tt>:
-* <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 }}
+Normal operation is to cut off all decimal zeroes from right in rounding:
-==Aliases==
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1 | 5 | 2 }}</syntaxhighlight> yields {{Percentage | 1 | 5 | 2 }}
-* <nowiki>{{pct}}</nowiki>
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | 1111 | 10000 | 4 }}</syntaxhighlight> yields {{Percentage | 1111 | 10000 | 4 }}
-* <nowiki>{{percent}}</nowiki>
+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:
-== See also ==
+* <syntaxhighlight lang="wikitext" inline>{{Percentage | 20 }}</syntaxhighlight> yields {{Percentage | 20 }}
-* {{tlx|Percent-done}}
+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 | % = &nbsp;percent}}</syntaxhighlight> yields {{Percentage | 1 | 3 | % = &nbsp;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": "&nbsp;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><!--
-++++ PLEASE ADD CATEGORIES AND INTERWIKIS BELOW THIS LINE, THANK YOU. -->
+++++ PLEASE ADD CATEGORIES BELOW THIS LINE, THANK YOU. -->{{basepage subpage|
 [[Category:Mathematical function templates|Percentage]]
+}}</includeonly>
-[[ro:Format:Procentaj]]
-[[vi:Bản mẫu:Tỷ lệ]]
-</includeonly>