Template:Numlinks/doc: Difference between revisions

(12 intermediate revisions by the same user not shown)

Line 1:

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

== Parameters ==

; <code>Current Num</code> (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 <code>#rmatch</code> or entered manually.

; <code>Link Format</code> (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 <code>%s</code>. 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.

; <code>Link Count</code> (optional; default <code>1</code>)

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

; <code>Min</code> (optional; default <code>1</code>)

: The minimum valid value for page numbers.

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

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

; <code>Is Ordinal</code> (optional; default <code>false</code>)

: Toggles whether to display numbers as ordinals.

; <code>Is Table</code> (optional; default <code>true</code>)

: 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

@@ Line 1: / Line 1: @@
-{{dochead}}{{lua}}
+{{dochead|header=metatemplate}}
 '''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.
+== Parameters ==
+; <code>Current Num</code> (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 <code>#rmatch</code> or entered manually.
+; <code>Link Format</code> (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 <code>%s</code>. 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.
+; <code>Link Count</code> (optional; default <code>1</code>)
+: The number of links to display before and after the current page.
+; <code>Min</code> (optional; default <code>1</code>)
+: The minimum valid value for page numbers.
+; <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.
+; <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.
+; <code>Is Ordinal</code> (optional; default <code>false</code>)
+: Toggles whether to display numbers as ordinals.
+; <code>Is Table</code> (optional; default <code>true</code>)
+: 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