Template:Pagelist

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Template documentationview · edit · history · purge ]
This documentation is transcluded from Template:Pagelist/doc.

Usage[edit]

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. |nspace=all Makes the parameters namespace-aware, i.e. not default to the mainspace.

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 ( · ), pipe ( | ), comma (, ), or tpt-languages ( • ).

This template is mostly useful from within other templates that accept a variable number of page names, up to twenty pages, 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[edit]

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, X2, X3, X4 and X5
{{Pagelist|nspace=all|delim=''|Portal:Birds|Wikipedia:Template editor}} Portal:Birds and Wikipedia:Template editor
{{Pagelist|X1}} X1
{{Pagelist}}
{{Pagelist|X1|X2|X3|separator=;}} X1;X2 and X3
{{Pagelist|X1|X2|X3|separator=; }} X1; X2 and X3
{{Pagelist|X1|X2|X3|conjunction=or}} X1, X2orX3
{{Pagelist|X1|X2|X3|conjunction= or }} X1, X2 or X3

Parameters[edit]

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

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 prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Namespacenspace

Namespace 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. "all" allows specifying lists of pages from multiple namespaces

Example
Template
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.

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.

Unbalanced wikitextoptional
Separatorseparator

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

Example
;
Stringoptional
Conjunctionconjunction

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

Example
or
Stringoptional
Page name 11

no description

Unbalanced wikitextoptional
Page name 22

no description

Unbalanced wikitextoptional
Page name 33

no description

Unbalanced wikitextoptional
Page name 44

no description

Unbalanced wikitextoptional
Page name 55

no description

Unbalanced wikitextoptional
Page name 66

no description

Unbalanced wikitextoptional
Page name 77

no description

Unbalanced wikitextoptional
Page name 88

no description

Unbalanced wikitextoptional
Page name 99

no description

Unbalanced wikitextoptional
Page name 1010

no description

Unbalanced wikitextoptional

See also[edit]