View source for Template:Plural/doc

{{distinguish|Template:Plural abbr}}
{{documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{#ifeq:{{SUBPAGENAME}}|sandbox||{{High-use}}}}

This template allows easy formatting of statements of the form "# thing(s)", with correct use of plurals. It uses the [[Help:Magic words#Language-dependent word conversions|"plural" magic word]], so it should work in other languages with minimal modification.
{{TOC_Right}}

==Usage==
With a space between the number and name (using [[numeric character reference]] <code>&amp;#32;</code>):
* <nowiki>{{</nowiki>plural|''number''|''name''}}
* <nowiki>{{</nowiki>plural|''number''|''singular name''|''plural name''}}

With a [[non-breaking space]] between the number and name (using [[character entity reference]] <code>&amp;nbsp;</code>):
* <nowiki>{{</nowiki>plural|''number''|''name''|nb=yes}}
* <nowiki>{{</nowiki>plural|''number''|''singular name''|''plural name''|nb=yes}}

==Examples==
For most English nouns, the plural is formed by adding "s" to the end of the singular form. If that is the case, only one "name" parameter is required:
* <code><nowiki>{{plural|0|page}}</nowiki></code> returns "{{plural|0|page}}"
* <code><nowiki>{{plural|1|page}}</nowiki></code> returns "{{plural|1|page}}"
* <code><nowiki>{{plural|2|page}}</nowiki></code> returns "{{plural|2|page}}"
* <code><nowiki>{{plural|-1|page}}</nowiki></code> returns "{{plural|-1|page}}"
* <code><nowiki>{{plural|-2|page}}</nowiki></code> returns "{{plural|-2|page}}"
* <code><nowiki>{{plural|0.5|page}}</nowiki></code> returns "{{plural|0.5|page}}"
* <code><nowiki>{{plural|1.5|page}}</nowiki></code> returns "{{plural|1.5|page}}"
* <code><nowiki>{{plural|-0.5|page}}</nowiki></code> returns "{{plural|-0.5|page}}"
* <code><nowiki>{{plural|-1.5|page}}</nowiki></code> returns "{{plural|-1.5|page}}"

For plurals that require adding "es", or more unusual forms, the singular and plural forms must be specified explicitly:
* <code><nowiki>{{plural|0|ox|oxen}}</nowiki></code> returns "{{plural|0|ox|oxen}}"
* <code><nowiki>{{plural|1|ox|oxen}}</nowiki></code> returns "{{plural|1|ox|oxen}}"
* <code><nowiki>{{plural|2|ox|oxen}}</nowiki></code> returns "{{plural|2|ox|oxen}}"
* <code><nowiki>{{plural|-1|ox|oxen}}</nowiki></code> returns "{{plural|-1|ox|oxen}}"
* <code><nowiki>{{plural|-2|ox|oxen}}</nowiki></code> returns "{{plural|-2|ox|oxen}}"
* <code><nowiki>{{plural|0.5|ox|oxen}}</nowiki></code> returns "{{plural|0.5|ox|oxen}}"
* <code><nowiki>{{plural|1.5|ox|oxen}}</nowiki></code> returns "{{plural|1.5|ox|oxen}}"
* <code><nowiki>{{plural|-0.5|ox|oxen}}</nowiki></code> returns "{{plural|-0.5|ox|oxen}}"
* <code><nowiki>{{plural|-1.5|ox|oxen}}</nowiki></code> returns "{{plural|-1.5|ox|oxen}}"

With parameter {{para|nb}}:
* <code><nowiki><div style="width:5em">{{plural|2|sesquipedalian|</nowiki>'''nb=yes'''<nowiki>}}</div></nowiki></code> returns: <div style="width: 5em;">{{plural|2|sesquipedalian|nb=yes}}</div>
* <code><nowiki><div style="width:5em">{{plural|2|sesquipedalian|</nowiki>'''nb=no'''<nowiki>}}</div></nowiki></code> returns: <div style="width: 5em;">{{plural|2|sesquipedalian|nb=no}}</div>

===Notes===
* While <code><nowiki>{{plural|#|sheep|sheep}}</nowiki></code> is valid, it is also fairly pointless.
* The template does not handle missing parameters 1 or 2: <code><nowiki>{{plural}}</nowiki></code> returns "{{plural}}"
* The template does not handle empty parameters 1 or 2: <code><nowiki>{{plural||}}</nowiki></code> returns "{{plural||}}"
* The template does not remove leading or trailing spaces in parameters 1 or 2: <code><nowiki>{{plural | 2 | page }}</nowiki></code> returns "{{plural | 2 | page }}"

==TemplateData==
{{TemplateDataHeader}}
<templatedata>{
	"description": "Allows easy formatting of statements using plural.",
	"params": {
		"1": {
			"label": "Number",
			"description": "The number of items: 0, 1, 2 etc.",
			"type": "number",
			"required": true
		},
		"2": {
			"label": "Singular name",
			"description": "The text to use when one item is specified",
			"type": "string",
			"required": true
		},
		"3": {
			"label": "plural name",
			"description": "The text to use when two or more items are specified. The default is to append the singular form with 's'.",
			"type": "string",
			"required": false
		},
		"4": {},
		"nb": {}
	}
}</templatedata>

==See also==
*{{tl|R from plural}}
*{{tl|R to plural}}
*{{tl|Singular}}
*{{tl|Singular and plural}}
*{{tl|Plural abbr}}

<includeonly>{{sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Mathematical function templates]]
}}</includeonly>