Template:cardinalbox/documentation

	Documentation for Template:cardinalbox. ^[edit]
	This page contains usage information, categories, interwiki links and other content describing the template.

This template generates a navigation box for cardinal number entries.

Avoid using this template for new languages/numbers. Instead, use {{number box}}.

It is not recommended to use this template any more, because it leads to a lot of duplication of information across pages. Instead, use {{number box}}, which relies on a central store of number information, keeping all information on a language's numbers in one place. If necessary, create a new module for the language in question and place it in a subpage of Module:number list; for example, Module:number list/data/ru for Russian. See one of the existing modules for examples of how to create a new one.

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 subst:.

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 {{{2}}} or {{{4}}} is included, the parameter value is displayed in the corresponding upper corner of the box. When parameter {{{5}}} or {{{6}}} 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 {{{2}}} or {{{4}}} will still be displayed. When both {{{2}}} and {{{5}}} (or both {{{4}}} and {{{6}}}) are omitted, that part of the navigation box displays no text. The first two examples (see examples) demonstrate how these unnamed parameters are used.

{{{1}}} : (required); ISO code for the language of the entry

{{{2}}} : (optional ¹); the symbolic form of the previous cardinal number

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

{{{4}}} : (optional ¹); the symbolic form of the following cardinal number

{{{5}}} : (optional); the written form of the previous cardinal number

{{{6}}} : (optional); the written form of the following cardinal number

¹ Parameter {{{2}}} is required when {{{5}}} is included; and {{{4}}} is required if {{{6}}} 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. second, fifth, hundredth)

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

mult= : the multiplier written form (e.g. double, triple, hundredfold)

dis= : the distributive number written form (e.g. singly, ternī)

coll= : the collective number written form (e.g. both, երկոքին (erkokʻin))

frac= : the fractional written form (e.g. half, ثُلْث (ṯulṯ))

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 opt=.

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 opt2=.

xs= : the full language name of the entry word ³

sc= : specifies a script code

wplink= : the article name on the corresponding language Wikipedia; do not include the ISO code since {{{1}}} takes care of that

alt= : the display form² of the cardinal number written form

ordalt= : (pairs with ord) the display form² of the ordinal number

advalt= : (pairs with adv) the display form² of the adverbial number

multalt= : (pairs with mult) the display form² of the multiplier

disalt= : (pairs with dis) the display form² of the distributive number

collalt= : (pairs with coll) the display form² of the collective number

fracalt= : (pairs with frac) the display form² of the fractional number

optxalt= : (pairs with optx) the display form² of the optional extra number

opt2xalt= : (pairs with opt2x) display form² of the second optional extra number

tr= : the transliteration⁴ of the cardinal number written form

ordtr= : (pairs with ord) the transliteration⁴ of the ordinal number

advtr= : (pairs with adv) the transliteration⁴ of the adverbial number

multtr= : (pairs with mult) the transliteration⁴ of the multiplier

distr= : (pairs with dis) the transliteration⁴ of the distributive number

colltr= : (pairs with coll) the transliteration⁴ of the collective number

fractr= : (pairs with frac) the transliteration⁴ of the fractional number

optxtr= : (pairs with optx) the transliteration⁴ of the optional extra number

opt2xtr= : (pairs with opt2x) the transliteration⁴ of the second optional extra number

² 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.
³ This is usually handled by including {{{1}}}, but may occasionally be broken by a missing template. In such cases, adding xs will correct the problem. ⁴ 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.