Template:ordinalbox/documentation

This template generates a navigation box for ordinal number entries.

Usage
This template may be added to the entry of any ordinal 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. One of these parameters is required; the others may be left blank.

When parameter is included, that value (e.g. 1st) is displayed in the top line of the box. 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 ordinal 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. When is not included, the entire top of the box collapses. 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 ordinal number


 * : (optional 2 ); the symbolic form of the ordinal number, e.g. 1st, 8e, 7ma


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


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


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

1 Parameter is required when  is included; and  is required if  is present. 2 Parameter is required if the top portion of the box is to be displayed.

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

When the parameter card, adv, mult, or dis 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.


 * card= : the cardinal 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., )


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


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


 * sc= : specifies a script code
 * alt= : the display form2 of the ordinal number written form


 * cardalt= : (pairs with card) the display form2 of the cardinal 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


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

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

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 noveno (999no) or for mil y primero (1001er) because large ordinal numbers are usually replaced by cardinal numbers in Spanish, so there is no reason to include links to them in the template.

( 2 ) - a minimal English 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 zeroth is the smallest ordinal number.
 * Note: The upper right corner of the box contains text and a link.

( 3 ) - a full English entry:

The above code displays as at right:


 * Note: A link to the Wikipedia article Fifth is included.

( 4 ) - a Latin entry:

The above code displays as at right:


 * Note: Latin has no ordinal abbreviations, so the unnamed parameters are omitted, and the top part of the box collapses.
 * 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.