View source for Template:Pluralize from text/doc

{{Documentation subpage}}
{{High use}}
{{Lua|Module:Detect singular}}
== Usage ==
<code><nowiki>{{Pluralize from text|generic parameter|singular=singular output|likely=likely plural output|plural=plural output|link=wikilink}}</nowiki></code><br/>
<code><nowiki>{{Pluralize from text|generic parameter|plural argument|singular output|plural output|wikilink}}</nowiki></code>

For use in infoboxes. Takes a generic parameter (e.g, {{para|nickname}}) and a plural argument (e.g., {{para|nicknames}}) and returns a singular output (e.g., "Nickname") if the plural argument is not given and [[Template:Detect singular]] determines that the value of {{para|nickname}} is singular by examining the text. Otherwise produces plural output (e.g., "Nicknames")

If the wikilink is provided, the returned value will use that as a link, and the output will be the link's display text.

The template makes a decision whether a string is a "likely plural" or a full "plural". The {{para|likely}} argument will be the output if the template determines that the string is only "likely plural". If {{para|likely}} is not given, "likely plural" and "plural" are treated identically.

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

===Options===
There are four named arguments that control the pluralization:
* {{para|no_comma}} By default, commas (or semi-colons) will cause the text string to be considered plural. Setting {{para|no_comma|1}} turns this behavior off.
* {{para|any_comma}} By default, commas (or semi-colons) that are adjacent to digits are singular. Setting {{para|any_comma|1}} turns this behavior off.
* {{para|no_and}} By default, "and" causes a string to be plural. Setting {{para|no_and|1}} turns this behavior off.
* {{para|parse_links}} By default, wikilinks are considered to be unparseable (singular) objects. Setting {{para|parse_links|1}} will allow the parser to read the contents of the wikilinks and determine whether that makes the string plural.

==Examples==
<code><nowiki>{{Pluralize from text|Chicagoan|singular=singular|plural=plural}}</nowiki></code> → {{Pluralize from text|Chicagoan|singular=singular|plural=plural}}

<code><nowiki>{{Pluralize from text|761 and 345|singular=singular|plural=plural}}</nowiki></code> → {{Pluralize from text|761 and 345|singular=singular|plural=plural}}

<code><nowiki>{{Pluralize from text||761/345|singular=singular|plural=plural}}</nowiki></code> → {{Pluralize from text||761/345|singular=singular|plural=plural}}

<code><nowiki>{{Pluralize from text|Chicagoan|singular=Demonym|plural=Demonyms|link=Demonym}}</nowiki></code> → {{Pluralize from text|Chicagoan|singular=Demonym|plural=Demonyms|link=Demonym}}

<code><nowiki>{{Pluralize from text|761 and 345|singular=Area Code|plural=Area Codes|link=Area code}}</nowiki></code> → {{Pluralize from text|761 and 345|singular=Area Code|plural=Area Codes|link=Area code}}

==TemplateData==
{{Format TemplateData|1=<templatedata>
{
	"params": {
		"1": {
			"label": "Generic parameter",
			"description": "Value of the wikitext parameter with unknown plurality",
			"type": "content",
			"required": true,
			"example": "{{{language|}}}"
		},
		"2": {
			"label": "Plural argument",
			"description": "value of the wikitext parameter known to be plural",
			"type": "string",
			"example": "{{{languages|}}}"
		},
		"3": {
			"label": "Singular output",
			"description": "Label for the parameter if the value is singular",
			"type": "string",
			"required": false,
            "aliases": ["singular"],
			"example": "Language"
		},
		"4": {
			"label": "Plural output",
			"description": "Label for the parameter if the value is plural",
			"type": "string",
			"required": false,
            "aliases": ["plural"],
			"example": "Languages"
		},
		"5": {
			"label": "Wikilink",
			"description": "Page to link to in the label",
			"type": "wiki-page-name",
            "aliases": ["link"],
			"example": "Language"
		},
        "no_comma": {
            "label": "Turn off comma processing",
            "description": "By default, commas and semicolons indicate plurals. Setting to yes turns this off.",
            "type": "string",
            "required": false,
            "default": "No"
        }  
	},
	"description": "Helper template to adjust infobox field labels based on whether value is plural or not",
	"paramOrder": [
		"1",
		"2",
		"3",
		"4",
		"5",
        "no_comma"
	]
}
</templatedata>}}

<includeonly>{{sandbox other||
<!-- Categories below this line -->

}}</includeonly>