Template:Numlinks/doc: Difference between revisions

From Xenharmonic Wiki
Jump to navigation Jump to search
Ganaram inukshuk (talk | contribs)
Created page with "{{dochead}}{{lua}} '''Template:Numlinks''' is intended as a meta-template (a template used to construct other templates), used to build {{w|WP:NAV|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."
 
Ganaram inukshuk (talk | contribs)
No edit summary
Line 3: Line 3:


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.
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 ==
; <code>Current Num</code> (required)
: The current number of the page. May be obtained by using <code>#rmatch</code> or similar.
; <code>Link Count</code>
: The number of links to display before and after the current page. Default is 1.
; <code>Min</code>
: The minimum valid value for page numbers. Default is 1.
; <code>Link Format</code>
: The text used for page links, where <code>%s</code> denotes the page number. Default is <code>%s</code>.
; <code>Display Format</code>
: Format for if the displayed text for the links is different, where <code>%s</code> denotes the page number. Default is to use the same value as <code>Link Format</code>.
; <code>Current Page Format</code>
: Format for if the current-page text different, where <code>%s</code> denotes the page number. Default is to use the same value as <code>Display Format</code>.
; <code>Is Ordinal</code>
: If set to true, this displays numbers as ordinals instead. Default is false.
; <code>Is Table</code>
: If set to true, this displays the output as a 1-row, 3-column table. Default is true.

Revision as of 07:34, 10 October 2025

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)
The current number of the page. May be obtained by using #rmatch or similar.
Link Count
The number of links to display before and after the current page. Default is 1.
Min
The minimum valid value for page numbers. Default is 1.
Link Format
The text used for page links, where %s denotes the page number. Default is %s.
Display 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
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
If set to true, this displays numbers as ordinals instead. Default is false.
Is Table
If set to true, this displays the output as a 1-row, 3-column table. Default is true.