Template:ordinalbox/documentation

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

This template generates a navigation box for ordinal 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.

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

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

{{{3}}} : (optional ²); the symbolic form of the ordinal number, e.g. 1st, 8^e, 7^ma

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

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

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

¹ Parameter {{{2}}} is required when {{{5}}} is included; and {{{4}}} is required if {{{6}}} is present.
² Parameter {{{3}}} is required if the top portion of the box is to be displayed.

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.

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

( 1 ) milésimo - a minimal Spanish entry:

{{ordinalbox | es | | 1000<sup>mo</sup> }}

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 ) zeroth - a minimal English entry:

{{ordinalbox | en | | 0th | 1st | | first }}

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 ) fifth - a full English entry:

{{ordinalbox | en | 4th | 5th | 6th | fourth | sixth | card=five | mult=fivefold | wplink=Fifth }}

The above code displays as at right:

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

( 4 ) octāvus - a Latin entry:

{{ordinalbox | la | card=octo | cardalt=octō | adv=octiens | advalt=octiēns | dis=octoni | disalt=octōnī }}

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.