Template:Pluralize from text/doc

{{Pluralize from text}} is used to detect if a text value is a plural list or not. Its intended usage is for infobox parameters, where the label might need to change from a singular version to a plural version.

For example, if an infobox uses a |nickname= parameter, the label might change from Nickname to Nicknames if the text value has more than one nickname.

The output of the template can be forced by including {{force singular}} or {{force plural}} in the generic parameter.

Usage

• {{Pluralize from text|text|singular=singular output|likely=likely plural output|plural=plural output|link=wikilink}}
• {{Pluralize from text|text|plural argument|singular output|plural output|wikilink}}

Parameters

There are five named parameters that control the pluralization:

• |no_comma= – By default, commas (or semicolons) will cause the text string to be considered plural. Setting |no_comma=1 turns this behavior off.
• |any_comma= – By default, commas (or semicolons) that are adjacent to digits are singular. Setting |any_comma=1 turns this behavior off.
• |no_and= – By default, "and" causes a string to be plural. Setting |no_and=1 turns this behavior off.
• |parse_links= – By default, Wikilinks are considered to be unparseable (singular) objects. Setting |parse_links=1 will allow the parser to read the contents of the Wikilinks and determine whether that makes the string plural.
• |parse_number= – Setting |parse_number=1 will cause the first integer in the string to determine plurality.

Additional parameters:

• |likely= – The template makes a decision whether a string is a "likely plural" or a full "plural". The |likely= argument will be the output if the template determines that the string is only "likely plural". If |likely= is not given, "likely plural" and "plural" are treated identically.
• |link= – If the Wikilink is provided, the returned value will use that as a link, and the output will be the link's display text.

TemplateData

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

TemplateData for Pluralize from text

Helper template to adjust infobox field labels based on whether value is plural or not

Parameter		Description	Type	Status
Generic parameter	1	Value of the wikitext parameter with unknown plurality Example {{{language|}}}	Content	required
Plural argument	2	value of the wikitext parameter known to be plural Example {{{languages|}}}	String	optional
Singular output	3 singular	Label for the parameter if the value is singular Example Language	String	optional
Plural output	4 plural	Label for the parameter if the value is plural Example Languages	String	optional
Wikilink	5 link	Page to link to in the label Example Language	Page name	optional
Turn off comma processing	no_comma	By default, commas and semicolons indicate plurals. Setting to "yes" turns this off. Default No	Boolean	optional
Any comma is plural	any_comma	By default, commas and semicolons that are adjacent to digits are singular. Setting to "yes" turns this behavior off. Default No	Boolean	optional
"And" is not plural	no_and	By default, "and" causes a string to be plural. Setting to "yes" turns this behavior off. Default No	Boolean	optional
Parse wikilinks	parse_links	By default, Wikilinks are considered to be unparseable (singular) objects. Setting to "yes" will allow the parser to read the contents of the Wikilinks and determine whether that makes the string plural. Default No	Boolean	optional
Parse numbers	parse_number	Setting to "yes" will cause the first integer in the string to determine plurality. Default No	Boolean	optional
Likely output	likely	Output when input is likely, but not certain, to be plural	String	optional

Examples

• {{Pluralize from text|Chicagoan|singular=singular|plural=plural}} → singular
• {{Pluralize from text|761 and 345|singular=singular|plural=plural}} → plural
• {{Pluralize from text|1=|2=761/345|singular=singular|plural=plural}} → plural
• {{Pluralize from text|Chicagoan|singular=Demonym|plural=Demonyms|link=Demonym}} → Demonym
• {{Pluralize from text|761 and 345|singular=Area Code|plural=Area Codes|link=Area code}} → Area Codes