View source for Template:Number to word/documentation

{{documentation subpage}}
Converts a given [[integer]] into a [[cardinal number]] or [[ordinal number]] in the English language. Anything between 10{{sup|126}} and −10{{sup|126}} is supported, as well as some larger numbers such as one centillion and one millinillion.

===Usage===
<code><nowiki>{{number to word|</nowiki>''integer''<nowiki>[|zero=</nowiki>''zero''<nowiki>][|adj=on][|us=on][|ord=on]}}</nowiki></code>

''integer'': Required. A natural number in the range of 10{{sup|126}} and −10{{sup|126}} 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 ===
{| class=wikitable
|-
| <nowiki>{{number to word|-999999|adj=on}}</nowiki>
| {{number to word|-999999|adj=on}}
|-
| <nowiki>{{number to word|-1001|us=on}}</nowiki>
| {{number to word|-1001|us=on}}
|-
| <nowiki>{{number to word|-235|us=on|adj=on}}</nowiki>
| {{number to word|-235|us=on|adj=on}}
|-
| <nowiki>{{number to word|-100}}</nowiki>
| {{number to word|-100}}
|-
| <nowiki>{{number to word|-30}}</nowiki>
| {{number to word|-30}}
|-
| <nowiki>{{number to word|0|zero=not a sausage|adj=on}}</nowiki>
| {{number to word|0|zero=not a sausage|adj=on}}
|-
| <nowiki>{{number to word|30}}</nowiki>
| {{number to word|30}}
|-
| <nowiki>{{number to word|100}}</nowiki>
| {{number to word|100}}
|-
| <nowiki>{{number to word|235|us=on|adj=on}}</nowiki>
| {{number to word|235|us=on|adj=on}}
|-
| <nowiki>{{number to word|1001}}</nowiki>
| {{number to word|1001}}
|-
| <nowiki>{{number to word|999999|adj=on}}</nowiki>
| {{number to word|999999|adj=on}}
|-
| <nowiki>{{number to word|999999|adj=on|ord=on}}</nowiki>
| {{number to word|999999|adj=on|ord=on}}
|-
| <nowiki>{{number to word|9999999999999999}}</nowiki>
| {{number to word|9999999999999999}}
|}

===Technical information===
This template uses [[Module:ConvertNumeric]].

===See also===
* {{temp|ordinal to word}} – does the same job as this template with {{para|ord|on}}

<includeonly>
[[Category:Number templates]][[Category:Text format templates]]
</includeonly>