Template:number box/documentation

This template generates a navigation box for number entries. It uses Module:number list as a back-end.

Parameters

|1= (required)

The language code (see Wiktionary:Languages).

|2= (optional)

The current number. Thousands separators are allowed. This can (and normally will) be omitted, because the module can automatically look up the correct number by matching the current page name (or the page name specified using |pagename=) against the number forms listed in the language-specific number data. The main reasons to include it are: (1) if the same page name corresponds to multiple numbers; (2) to save memory, e.g. on lima, because the table that maps number forms to numbers takes nontrivial amounts of memory and is built only if |2= is omitted.

|pagename= (optional)

An alternate page name, if you want the number box to display as if it were on a different page name. Normally, the module automatically determines the type of number (cardinal, ordinal, distributive, etc.) from the page name by looking in the number data for this language. This parameter can be used for testing, on documentation pages, or if the current page name is not found in the language's number data (e.g. because it is an alternative form; but in this case, consider adding the page name to the language data).

|type= (optional)

The type of number (cardinal, ordinal, etc.). Must be a key in the table for the number in the correct data module. Only needed if two numbers have the same entry name.

Usage

This template may be added to the entry of any number, whether a cardinal number, ordinal number or any other kind. In languages where number words are inflected, add the template only to the lemma form, not to any of the other forms.

The template should be placed within a language section, immediately following the L2 language header.

Types

The following values are recognized by default for the type parameter (some languages may specify additional types):

Type	Display as
cardinal	Cardinal
ordinal	Ordinal
ordinal_abbr	Ordinal abbreviation
adverbial	Adverbial
multiplier	Multiplier
distributive	Distributive
collective	Collective
fractional	Fractional

Operational details

The template uses a data module for each language which contains a list of numbers and the various subtypes for each one (cardinal, ordinal etc.). When the template is added to an entry, the subtypes of the given number (parameter 2) are searched for the current page name, which lets the template automatically figure out what type of number the current page is. Links are then generated to the previous and next item of this type, i.e. adding it to third will automatically create links to second and fourth.

The data modules are subpages of Module:number list/data, named by language code. So for example, the data for English numbers is in Module:number list/data/en.