Template:cardinalbox/documentation

This template generates a navigation box for cardinal number entries.

Usage
This template may be added to the entry of any cardinal number. In languages that inflect numerals, please add the template only to the lemma form.

The template should be placed within a language section, immediately following the L2 language header. As with other Wiktionary navigation box templates, please do not use .

Unnamed parameters
The template uses up to 6 unnamed parameters, as described below. Two of these parameters are required; the others may be left blank.

When parameter or  is included, the parameter value is displayed in the corresponding upper corner of the box. When parameter or  is included, a link is generated to the previous or following cardinal number entry. When either of these parameters is omitted, the corresponding link is not made, but or  will still be displayed. When both and  (or both  and ) are omitted, that part of the navigation box displays no text. The first two examples (see examples) demonstrate how these unnamed parameters are used.


 * : (required); ISO code for the language of the entry


 * : (optional 1 ); the symbolic form of the previous cardinal number


 * : (required); the symbolic form of the cardinal number, e.g. 2, 15, 100


 * : (optional 1 ); the symbolic form of the following cardinal number


 * : (optional); the written form of the previous cardinal number


 * : (optional); the written form of the following cardinal number

1 Parameter is required when  is included; and  is required if  is present.

Named parameters
Additional named parameters allow for links to be made from the box, but usually none are required.

When the parameter ord, adv, mult, dis, coll, frac, or opt is included, an additional line of text is added to the navigation box. When any of these parameters is omitted, the corresponding text line is not generated.


 * ord= : the ordinal number written form (e.g., , )


 * adv= : the adverbial number written form (e.g., )


 * mult= : the multiplier written form (e.g., , )


 * dis= : the distributive number written form (e.g., )


 * coll= : the collective number written form (e.g., )


 * frac= : the fractional written form (e.g., )


 * headlink= : the link target for the box header, such as a Glossary or Appendix on cardinal numbers in the language


 * opt= : any optional extra type of number form not listed above (e.g. Counting form, Archaic form, etc)


 * optx= : specifies the value of the optional extra number form specified in.


 * opt2= : a second optional extra type of number form not listed above (e.g. fractional form, etc)


 * opt2x= : specifies the value of the second optional extra number form specified in.


 * xs= : the full language name of the entry word 3


 * sc= : specifies a script code


 * wplink= : the article name on the corresponding language Wikipedia; do not include the ISO code since takes care of that
 * alt= : the display form2 of the cardinal number written form


 * ordalt= : (pairs with ord) the display form2 of the ordinal number


 * advalt= : (pairs with adv) the display form2 of the adverbial number


 * multalt= : (pairs with mult) the display form2 of the multiplier


 * disalt= : (pairs with dis) the display form2 of the distributive number


 * collalt= : (pairs with coll) the display form2 of the collective number


 * fracalt= : (pairs with frac) the display form2 of the fractional number


 * optxalt= : (pairs with optx) the display form2 of the optional extra number


 * opt2xalt= : (pairs with opt2x) display form2 of the second optional extra number


 * tr= : the transliteration4 of the cardinal number written form


 * ordtr= : (pairs with ord) the transliteration4 of the ordinal number


 * advtr= : (pairs with adv) the transliteration4 of the adverbial number


 * multtr= : (pairs with mult) the transliteration<sup style="color: #F00">4 of the multiplier


 * distr= : (pairs with dis) the transliteration<sup style="color: #F00">4 of the distributive number


 * colltr= : (pairs with coll) the transliteration<sup style="color: #F00">4 of the collective number


 * fractr= : (pairs with frac) the transliteration<sup style="color: #F00">4 of the fractional number


 * optxtr= : (pairs with optx) the transliteration<sup style="color: #F00">4 of the optional extra number


 * opt2xtr= : (pairs with opt2x) the transliteration<sup style="color: #F00">4 of the second optional extra number

<sup style="color: #F00">2 This parameter is only used for languages where the display form and pagename do not match. For each "alt" parameter, use the display form (with diacriticals) and not the target page name. Please refer to the Latin example in the next section for clarification. <sup style="color: #F00">3 This is usually handled by including, but may occasionally be broken by a missing template. In such cases, adding xs will correct the problem. <sup style="color: #F00">4 This parameter is only used for languages in non-Latin scripts, and only where either no automatic transliteration is supplied or where such transliteration is incorrect. Please refer to the Arabic example in the next section for clarification.

Examples
( 1 ) - a minimal Spanish entry:

The above code displays as at right:


 * Note: Most parameters are omitted, and so do not display. In particular, there is no entry for novecientos noventa y nueve (999) or for mil y uno (1001), so there is no reason to include links to them in the template.

( 2 ) - a minimal Portuguese entry:

The above code displays as at right:


 * Note: Most parameters are omitted, and so do not display.
 * Note: The second parameter is omitted, so the upper left corner of the box contains no text. This is done because zero is the smallest cardinal number.
 * Note: The upper right corner of the box contains text and a link.

( 3 ) - an English entry:

The above code displays as at right:


 * Note: A link to the Wikipedia article 2 (number) is included.

( 4 ) - a Latin entry:

The above code displays as at right:


 * Note: The header links to Appendix:Latin cardinal numerals.
 * Note: The "alt" parameters permit the display of macrons, even though the page names for the entries do not have macrons.
 * Note: The multiplier parameter is omitted, so that line of text does not appear in the box.

( 5 ) - a Russian entry:

The above code displays as at right:


 * Note: The parameter sc=Cyrl specifies the use of the Cyrillic script.
 * Note: A link to the Russian Wikipedia article 15 (число) is included.

( 6 ) - an Ancient Greek entry:



The above code displays as at right:


 * Note: The header links to Appendix:Ancient Greek numerals.
 * Note: No link to the Ancient Greek Wikipedia is included, so the bottom of the box collapses.

( 7 ) - a Rapa Nui entry:



The above code displays as at right:


 * Note: Rapa Nui numerals have an adjectival form and a counting form, made with the prefix.
 * Note: has been set to Counting form, so a row appears with it and the form in question, kaha.

( 8 ) - a Latvian entry:



The above code displays as at right:


 * Note: Latvian numerals from 1 to 9 have both a nominalized form in (meaning "the cipher/digit X", "something with X written on it", "a group of X people/animals/things") and a fractional form compounded with . In order to show these forms, both / and / had to be used.
 * Note: wplink provides a pagename in the Latvian wikipedia for this number.

( 9 ) - an Arabic entry:



The above code displays as at right:


 * Note: Transliteration parameters are necessary in order to get the dash after wa ("and").