Template:Numlinks

Template documentation[view] [edit] [history] [purge]

This template is a metatemplate. It is used to build other templates and should not be used standalone, except for testing or simple usage. This template is implemented by the Lua module Module:Numlinks.

This template invokes the following functions: numlinks from Numlinks.

Template:Numlinks is intended as a meta-template (a template used to construct other templates), used to build navigational templates. This can be used directly, or by using its corresponding module, Module:Numlinks.

For a numbered page, such as 12edo or 12th-octave temperaments, this template generates links to its next and previous pages. This is meant for pages for which there are no intended gaps in the sequence of pages.

Parameters

Current Num (required; default is the first number in the page's name)

The current number of the page. By default, this is the first occurrence of a number in the page's name; if this is the wrong number, it may be specified using #rmatch or entered manually.

Link Format (required; default is the page's name)

The text used for page links, as a format string. By default, this is the page's name, where the number is replaced with %s. If there are multiple numbers, or the number is an ordinal (1st, 2nd, etc), it's necessary to enter the format string manually to avoid issues.

Link Count (optional; default 1)

The number of links to display before and after the current page.

Min (optional; default 1)

The minimum valid value for page numbers.

Display Format (optional; default is to use Link Format)

Format for if the displayed text for the links is different, where %s denotes the page number.

Current Page Format (optional; default is to use Display Format)

Format for if the current-page text different, where %s denotes the page number.

Is Ordinal (optional; default false)

Toggles whether to display numbers as ordinals.

Is Table (optional; default true)

Toggles whether to output links as a 1-row 3-column table or as one line.

See also

• Template:Numlinks 2-num, an equivalent template for two varying page numbers