Template:Collapsible list/doc
 | Template:Strong for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
 | This template uses Lua: |
This template produces a collapsible list. It is possible to set CSS styles for the "frame" (the <div>...</div> tags surrounding the list), for the list title, and for the list items. The template supports an unlimited number of list items.
This template is typically used in infoboxes and navboxes; it should not normally be used in regular article content, per MOS:DONTHIDE.
Regarding using this template in infoboxes, MOS:DONTHIDE acknowledges that "a few infoboxes also use pre-collapsed sections for infrequently accessed details. If [such] information ... seems extraneous or trivial enough to inspire pre-collapsing it, consider raising a discussion on the article (or template) talk page about whether it should be included at all."
| Collapsible templates | ||||
|---|---|---|---|---|
|
||||
| Article namespace | ||||
|
||||
| Infoboxes | ||||
| Navigation templates | ||||
| Talk namespace | ||||
|
||||
Syntax
<syntaxhighlight lang="html" style="font-size:95%;overflow:auto;">
</syntaxhighlight>
Parameters
| expand | Any text in this parameter (including "no") sets the list's default state to expanded rather than collapsed. Omit the parameter or leave it blank to set the default state to collapsed. |
| framestyle | Custom CSS styling applied the template overall (title and list). |
| titlestyle | Custom CSS styling applied to the title. |
| title | The list's title (always on view beside the list's [show/hide] link). |
| liststyle | Custom CSS styling applied to the list (specifically, to the <ul>...</ul> tags delimiting the list). |
| hlist | Include as |hlist=on, |hlist=true, etc to produce a horizontal rather than vertical list. |
| bullets | Include as |bullets=on, |bullets=true, etc to place a bullet point before each list item. |
| Unnamed parameters (first, second, third...) | The list items (in the order in which they will appear). If none are supplied, the template outputs nothing. |
Examples
<syntaxhighlight lang="Moin" style="font-size:95%;overflow:auto;">
</syntaxhighlight>
Example of a list without borders because it is within an infobox
In these examples, the fields leader_name2 and leader_name3 have been changed to use collapsible list.
City of Hamilton | |
|---|---|
 | |
| Motto: Together Aspire – Together Achieve | |
| Country | Canada |
| Province | Ontario |
| Incorporated | June 9, 1846 |
| Government | |
| • Mayor | Fred Eisenberger |
| • City Council | Hamilton, Ontario, City Council |
| • MPs | |
| • MPPs | |
<syntaxhighlight lang="html" style="font-size:95%; overflow:auto;">
City of Hamilton
...truncated... | |
|---|---|
| Incorporated | June 9, 1846 (...etc...) |
| Government | |
| • Mayor | Fred Eisenberger |
| • City Council | Hamilton City Council |
| • MPs | |
| • MPPs | |
</syntaxhighlight>
TemplateData
TemplateData for Collapsible list
<templatedata> { "params": { "1": { "label": "First list item", "description": "A single list item", "type": "content", "suggested": true }, "2": { "label": "Second list item", "description": "A single list item", "type": "content", "suggested": true }, "3": { "label": "Third list item", "description": "A single list item", "type": "content", "suggested": true }, "4": { "label": "Fourth list item", "description": "A single list item", "type": "content" }, "5": { "type": "content" }, "6": { "type": "content" }, "7": { "type": "content" }, "8": { "type": "content" }, "9": { "type": "content" }, "10": { "type": "content" }, "expand": { "label": "Expand list", "description": "Expand the list instead of collapsing it", "example": "true", "type": "string", "autovalue": "true" }, "framestyle": { "aliases": [ "frame_style" ], "label": "Frame style", "description": "Custom CSS styling applied the template overall (title and list).", "example": "border: 1px;", "type": "string" }, "titlestyle": { "aliases": [ "title_style" ], "label": "Title style", "description": "CSS styling applied to the title", "example": "color:brown;", "type": "string" }, "title": { "label": "Title", "description": "The list's title (Always in view beside the list's [show/hide] link).", "type": "string", "suggested": true }, "liststyle": { "aliases": [ "list_style" ], "label": "List style", "description": "CSS styling applied solely to the list itself", "example": "list-style-type: square;", "type": "string" }, "hlist": { "label": "Horizontal list", "description": "Use value 'on' or 'true' to produce a horizontal rather than vertical list", "example": "true", "type": "string", "autovalue": "true" }, "bullets": { "label": "Bullets", "description": "Set as 'on' or 'true' to place a bullet point before each list item", "example": "true", "type": "string", "autovalue": "true" } }, "description": "Produces an HTML list that can be collapsed", "paramOrder": [ "title", "hlist", "bullets", "expand", "1", "framestyle", "titlestyle", "liststyle", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "format": "block" } </templatedata>