Template:Numlinks/doc: Difference between revisions

Ganaram inukshuk (talk | contribs)
No edit summary
Ganaram inukshuk (talk | contribs)
Line 5: Line 5:


== Parameters ==
== Parameters ==
; <code>Current Num</code> (required)
; <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.
: 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)
; <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.
: 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.


Line 18: Line 18:


; <code>Display Format</code> (optional; default is to use <code>Link 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.


; <code>Current Page Format</code> (optional; default is to use <code>Display 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.


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