Template:Numlinks/doc

This template is implemented by the Lua module Module:Numlinks.

This template invokes the following functions: numlinks from Numlinks.

This template has been deprecated. Its replacements are Template:Dochead and Template:Module introspection.

This template uses Lua: Module: 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)

The current number of the page. May be obtained by using #rmatch or similar.

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.

Link Format (optional; default %s)

The text used for page links, where %s denotes the page number.

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. Default is to use the same value as Link Format.

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

Format for if the current-page text different, where %s denotes the page number. Default is to use the same value as Display Format.

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.