RexxS: Creating Module:UnitPlural/doc

2019-10-14T15:02:05Z

Creating Module:UnitPlural/doc

New page

{{Module rating |beta}}


== Function main ==

The main function takes a number and unit name ({{para|quantity}}) and an optional language code ({{para|lang}}) from the frame.

It returns the quantity with proper plural units in the given language, if it can.

It will find use when the quantity is returned from Wikidata, so that the numerical value is not yet known.

=== Examples ===

* <code><nowiki>{{#invoke:UnitPlural |main |quantity=1 week}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=1 week}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3 week}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3 week}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3.50 week}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3.50 week}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=1 foot}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=1 foot}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3 foot}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3 foot}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=1 mile per hour}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=1 mile per hour}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3 mile per hour}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3 mile per hour}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=1 standard gravity}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=1 standard gravity}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3 standard gravity}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3 standard gravity}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=1 foot}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=1 solar mass}}
* <code><nowiki>{{#invoke:UnitPlural |main |quantity=3 solar mass}}</nowiki></code> → {{#invoke:UnitPlural |main |quantity=3 solar mass}}

== Function plural ==

Function plural is equivalent to function main(frame), but takes parameters for use in other modules. The langcode is optional and is "{{#invoke:WikidataIB|findLanguage}}" by default on {{#invoke:WikidataIB|globalSiteID}}.
* quant = plural(quant, langcode)

== Function pl ==

Function pl returns the plural of the unit name, and takes parameters for use in other modules. The langcode is optional and is "{{#invoke:WikidataIB|findLanguage}}" by default on {{#invoke:WikidataIB|globalSiteID}}.
* unitnameplural = pl(unitname, langcode)

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |


}}</includeonly>

Module:UnitPlural/doc - Revision history

RexxS: Creating Module:UnitPlural/doc