Template:Numlinks/doc: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary Tag: Manual revert |
|||
| Line 8: | Line 8: | ||
: The current number of the page. May be obtained by using <code>#rmatch</code> or similar. | : The current number of the page. May be obtained by using <code>#rmatch</code> or similar. | ||
; <code>Link Count</code> | ; <code>Link Count</code> (optional; default <code>1</code>) | ||
: The number of links to display before and after the current page | : The number of links to display before and after the current page. | ||
; <code>Min</code> | ; <code>Min</code> (optional; default <code>1</code>) | ||
: The minimum valid value for page numbers | : The minimum valid value for page numbers. | ||
; <code>Link Format</code> | ; <code>Link Format</code> (optional; default <code>%s</code>) | ||
: The text used for page links, where <code>%s</code> denotes the page number | : The text used for page links, where <code>%s</code> denotes the page number. | ||
; <code>Display Format</code> | ; <code>Display Format</code> (optional; default is to use <code>Link 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>. | : 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> | ; <code>Current Page Format</code> (optional; default is to use <code>Display 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>. | : 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> | ; <code>Is Ordinal</code> (optional; default <code>false</code>) | ||
: If set to true, this displays numbers as ordinals instead | : If set to true, this displays numbers as ordinals instead. | ||
; <code>Is Table</code> | ; <code>Is Table</code> (optional; default <code>true</code>) | ||
: If set to true, this displays the output as a 1-row, 3-column table. | : If set to true, this displays the output as a 1-row, 3-column table. If set to false, this outputs links as one line. | ||
Revision as of 08:37, 10 October 2025
- 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: |
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
#rmatchor similar.
Link Count(optional; default1)- The number of links to display before and after the current page.
Min(optional; default1)- The minimum valid value for page numbers.
Link Format(optional; default%s)- The text used for page links, where
%sdenotes the page number.
Display Format(optional; default is to useLink Format)- Format for if the displayed text for the links is different, where
%sdenotes the page number. Default is to use the same value asLink Format.
Current Page Format(optional; default is to useDisplay Format)- Format for if the current-page text different, where
%sdenotes the page number. Default is to use the same value asDisplay Format.
Is Ordinal(optional; defaultfalse)- If set to true, this displays numbers as ordinals instead.
Is Table(optional; defaulttrue)- If set to true, this displays the output as a 1-row, 3-column table. If set to false, this outputs links as one line.