Template:Transclude list/doc
 | This is a documentation subpage for Template:Transclude list. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is rated as alpha. It is ready for third party input, and may be used on a few pages to see if problems arise, but should be watched. Suggestions for new features or changes in their input and output mechanisms are welcome. |
Transclude list transcludes one bulleted or numbered list from the source page, disregarding the rest. It is designed for cases when a list has a sublist defined on another page.
This template returns the first list on a page, or the nth with |list=n. A list is one or more adjacent lines, each beginning with * or #.
For the match (see Module:String#match):
- source is the transcluded text of the entire page, plus a trailing newline and space (to terminate any list at end of page)
- pattern is:
- start of string or a newline (see %f and %z in mw:LUAREF)
- * or # followed by any text (non-greedy, may include newlines) – this is the returned value
- newline
- any character except * or # (a second newline also matches)
For example, a list of people sharing the surname Bernier may transclude contents listed on disambiguation page Melanie Bernier. That reduces maintenance effort and facilitates consistency between pages.
Usage
[edit]{{ Transclude list | SourcePageName | list=Number }}
Parameters
[edit]The template requires one parameter: the name of the page to be transcluded. Include a namespace where necessary. It accepts one optional named parameter: list=n to return the nth list rather than the first.
TemplateData
[edit]TemplateData for Transclude list
Transclude list transcludes a list from another page
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| 1 | 1 | The name of the page to be transcluded
| Page name | required |
| List | list | Serial number of the list to be transcluded
| Number | optional |