Template:Number to word/doc

This is a documentation subpage for Template:Number to word.
It may contain usage information, categories and other content that is not part of the original template page.

This template uses Lua:

Module:ConvertNumeric (sandbox)

This template is used in MediaWiki:Watchlist-messages, and on approximately 8,000 pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

Converts a given integer into a cardinal number or ordinal number in the English language. Anything between 10¹²⁶ and -10¹²⁶ is supported, as well as some larger numbers such as one centillion and one millinillion.

Usage

{{Number to word|integer[|zero=zero][|adj=on][|us=on][|ord=on]}}

integer: Required. A natural number in the range of 10¹²⁶ and -10¹²⁶ is, as well as some larger numbers such as one centillion and one millinillion.

zero: Optional. The value to use when the number is 0. Default is "zero" for cardinal numbers, "zeroth" for ordinal numbers. Can be made empty or, for example, "none", "seed" or "one before the first" as appropriate for the context.

adj: Optional. If the value is "on", the output is hyphenated.

ord: Optional. If the value is "on", the output is an ordinal number, otherwise it is a cardinal number.

us: Optional. If the value is "on", the output of numbers does not include "and" to separate hundreds from smaller values, nor to separate thousands from hundreds. This accords with American usage as described at English numerals.

Examples

Markup	Renders as
{{Number to word\|-999999\|adj=on}}	negative-nine-hundred-ninety-nine-thousand-nine-hundred-and-ninety-nine
{{Number to word\|-1001\|us=on}}	negative one thousand one
{{Number to word\|-235\|us=on\|adj=on}}	negative-two-hundred-thirty-five
{{Number to word\|-100}}	negative one hundred
{{Number to word\|-30}}	negative thirty
{{Number to word\|0\|zero=not a sausage\|adj=on}}	not-a-sausage
{{Number to word\|30}}	thirty
{{Number to word\|100}}	one hundred
{{Number to word\|235\|us=on\|adj=on}}	two-hundred-thirty-five
{{Number to word\|1001}}	one thousand and one
{{Number to word\|999999\|adj=on}}	nine-hundred-ninety-nine-thousand-nine-hundred-and-ninety-nine
{{Number to word\|999999\|adj=on\|ord=on}}	nine-hundred-ninety-nine-thousand-nine-hundred-and-ninety-ninth
{{Number to word\|9999999999999999}}	nine quadrillion nine hundred ninety-nine trillion nine hundred ninety-nine billion nine hundred ninety-nine million nine hundred ninety-nine thousand nine hundred and ninety-nine

Template:Number to word/doc

Usage

Examples

See also