Template:Pagelist/doc

From MattWiki
Jump to: navigation, search

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}} X1, X2, X3, X4 and X5
{{Pagelist|nspace=Template|X1|X2|X3|X4|X5}} X1, X2, X3, X4 and X5
{{Pagelist|nspace= |delim=''|X1|X2|X3|X4|X5}} [[::X1|X1]], [[::X2|X2]], [[::X3|X3]], [[::X4|X4]] and [[::X5|X5]]

Parameters

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Pagelist

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.

Template parameters

This template has custom formatting.

ParameterDescriptionTypeStatus
Namespacenspace

Namsespace on which the page is located, without the trailing colon (":"). Acceptable values are "Talk", "File", "File talk", "Category", "Category talk", "Help", "Help talk", "Wikipedia", "Wikipedia talk", "Portal", "Portal talk", "Template", "Template talk", "Module", "Module talk", "User", "User talk", and anything added in the future.

Default
empty
Example
Template
Auto value
empty
Stringoptional
Prefix (starting delimiter)delim

Wikicode to insert before each page name. Default is nothing. If this parameter is specified and no suffix parameter is specified, the contents of this parameter would also be used as the suffix.

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Suffix (ending delimiter)edelim

Wikicode to insert after each page name. If not specified, the default is the value of the prefix parameter.

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Separatorseparator

The character(s) used to separate specified page names, excluding the last two. Default is comma.

Default
empty
Example
;
Auto value
empty
Stringoptional
Conjunctionconjunction

The character(s) used to separate the last two items. Default is "and".

Default
empty
Example
or
Auto value
empty
Stringoptional
Page name 11

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 22

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 33

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 44

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 55

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 66

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 77

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 88

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 99

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional
Page name 1010

no description

Default
empty
Example
empty
Auto value
empty
Unbalanced wikitextoptional

See also

Module:Pagelist, the Lua module this template is based on