Template:Pagelist/doc
This is a documentation subpage for Template:Pagelist. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template uses Module:Pagelist, a script written in the Lua programming language. Please see Wikipedia:Lua if you want to learn more about Lua or help convert other templates. |
Usage
This template creates a comma-separated list of pages formatted as links. The last two pages in the list are separated by "and" instead of a comma. Any number of pages may be included in the list.
By default, the namespace of the page including this template is used for each of the links. An optional 'nspace'
parameter can be specified to provide a different namespace to use for the links.
Two other optional parameters are supported to provide formatting of the page links. If specified, the delim
parameter is included before and after each page name. Optionally, the edelim
parameter can specify the delimiter used at the end of the page name—in this case the delim
tag is still used for the beginning of the page name.
It is possible to specify a custom separator (instead of a comma) using the separator
parameter. It is also possible to specify a custom value to use instead of "and" before the final item using the conjunction
parameter. For both of these parameters, there are special values that use the default separators for the language set in users' preferences: dot
(⧼dot-separator⧽
), pipe
( |
), comma
(,
), or tpt-languages
(⧼tpt-languages-separator⧽
).
This template is mostly useful from within other templates that accept a variable number of page names as arguments. For example, the page arguments {{{1}}}
–{{{10}}}
can be passed to this template using {{pagelist|{{{1|}}}|{{{2|}}}|{{{3|}}}|{{{4|}}}|{{{5|}}}|{{{6|}}}|{{{7|}}}|{{{8|}}}|{{{9|}}}|{{{10|}}}}}
. Any parameters not specified to the original template will be passed as empty parameters and not listed by the pagelist template.
Examples
Type this | To get this |
---|---|
{{Pagelist|X1|X2|X3|X4|X5}}
|
Script error: No such module "pagelist". |
{{Pagelist|nspace=Template|X1|X2|X3|X4|X5}}
|
Script error: No such module "pagelist". |
{{Pagelist|nspace= |delim=''|X1|X2|X3|X4|X5}}
|
Script error: No such module "pagelist". |
See also
Module:Pagelist, the Lua module this template is based on