Template:Pagelist/doc
 | Note: This template is used on a lot of pages. In order not to put too much load on the servers, edits should be kept to a bare minimum. Please discuss proposed changes on the talk page first.
|
 | Uses Lua: |
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 (⧼tpt-languages-separator⧽).
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
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.
Wikipedia's help about TemplateData • Commons-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.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Namespace | nspace | 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
| String | optional |
| 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 wikitext | optional |
| Suffix (ending delimiter) | edelim | Wikicode to insert after each page name. If not specified, the default is the value of the prefix parameter. | Unbalanced wikitext | optional |
| Separator | separator | The character(s) used to separate specified page names, excluding the last two. Default is comma.
| String | optional |
| Conjunction | conjunction | The character(s) used to separate the last two items. Default is "and".
| String | optional |
| Page name 1 | 1 | no description | Unbalanced wikitext | optional |
| Page name 2 | 2 | no description | Unbalanced wikitext | optional |
| Page name 3 | 3 | no description | Unbalanced wikitext | optional |
| Page name 4 | 4 | no description | Unbalanced wikitext | optional |
| Page name 5 | 5 | no description | Unbalanced wikitext | optional |
| Page name 6 | 6 | no description | Unbalanced wikitext | optional |
| Page name 7 | 7 | no description | Unbalanced wikitext | optional |
| Page name 8 | 8 | no description | Unbalanced wikitext | optional |
| Page name 9 | 9 | no description | Unbalanced wikitext | optional |
| Page name 10 | 10 | no description | Unbalanced wikitext | optional |
See also
[edit]- {{Article list}}, which converts a list of QIDs into wikilinks
- {{Catlist}}, for a list of linked categories
- {{Comma separated entries}}
- {{Catalog lookup link}}