Difference between revisions of "Template:Collapsible list/doc"
imported>Tahir mq |
imported>WOSlinker m (change source to syntaxhighlight) |
||
| (33 intermediate revisions by 21 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{Documentation subpage}} |
| + | {{Template shortcuts|clist}} | ||
| + | {{lua|Module:Collapsible list}} | ||
| + | |||
| + | This template produces a collapsible list. It is possible to set [[CSS]] styles for the "frame" (the {{tag|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 [[WP:Infobox|infoboxes]] and [[WP:NAVBOX|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 [[Wikipedia:What Wikipedia is not#Wikipedia is not an indiscriminate collection of information|included at all]]." | ||
| + | |||
| + | {{Collapse Templates}} | ||
== Syntax == | == Syntax == | ||
| − | < | + | <syntaxhighlight lang="html" style="font-size:95%;overflow:auto;"> |
{{Collapsible list | {{Collapsible list | ||
| − | |framestyle = | + | | expand = |
| − | |title = | + | | framestyle = |
| − | | | + | | titlestyle = |
| − | | | + | | title = |
| − | |1 = | + | | liststyle = |
| − | |2 = | + | | hlist = |
| − | |3 = | + | | bullets = |
| − | | | + | | 1 = <!--(First item in list; the "1 =" is usually not required)--> |
| + | | 2 = <!--(Second item in list; ditto)--> | ||
| + | | 3 = <!--(Third item in list; etc.)--> | ||
| + | | <!-- etc --> | ||
}} | }} | ||
| − | </ | + | </syntaxhighlight> |
| − | ; | + | == Parameters == |
| − | + | {{Aligned table | |
| + | |style=line-height:1.35em; | ||
| + | |col1style=padding-right:1.5em; |col2style=vertical-align:middle; | ||
| + | | ''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 {{tag|ul}} tags delimiting the list). | ||
| + | | ''hlist'' | Include as {{para|hlist|on}}, {{para|hlist|true}}, etc to produce a horizontal rather than vertical list. | ||
| + | | ''bullets'' | Include as {{para|bullets|on}}, {{para|bullets|true}}, etc to place a [[Bullet (typography)|bullet point]] before each list item. | ||
| + | | Unnamed parameters<br>(first, second, third...) | The list items (in the order in which they will appear). If none are supplied, the template outputs nothing. | ||
| + | }} | ||
== Examples == | == Examples == | ||
| − | < | + | <syntaxhighlight lang="Moin" style="font-size:95%;overflow:auto;"> |
| − | {{Collapsible list | + | {{Collapsible list |
| − | |title=[[European Free Trade Association]] | + | | title = [[European Free Trade Association]] members |
| − | |[[Iceland]] | + | | [[Iceland]] |
| − | |[[Liechtenstein]] | + | | [[Liechtenstein]] |
| − | |[[Norway]] | + | | [[Norway]] |
| − | |[[Switzerland]]}} | + | | [[Switzerland]] |
| − | </ | + | }} |
| − | {{ | + | </syntaxhighlight> |
| + | {{collapsible list |title=[[European Free Trade Association]] members |[[Iceland]] |[[Liechtenstein]] |[[Norway]] |[[Switzerland]]}} | ||
| − | ===Example of a list without borders because it | + | === 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. | In these examples, the fields leader_name2 and leader_name3 have been changed to use collapsible list. | ||
{{Infobox settlement | {{Infobox settlement | ||
|official_name = City of Hamilton | |official_name = City of Hamilton | ||
| − | |motto = Together Aspire | + | |motto = Together Aspire – Together Achieve |
|image_skyline = HamiltonOntarioSkylineC.JPG | |image_skyline = HamiltonOntarioSkylineC.JPG | ||
|imagesize = 250px | |imagesize = 250px | ||
| − | |image_caption = | + | |image_caption = <!-- |
|image_map = Map of Ontario HAMILTON.svg | |image_map = Map of Ontario HAMILTON.svg | ||
|mapsize = 200px | |mapsize = 200px | ||
| − | |map_caption = Location in the province of Ontario, Canada | + | |map_caption = Location in the province of Ontario, Canada--> |
|subdivision_type = Country | |subdivision_type = Country | ||
| − | |subdivision_name = | + | |subdivision_name = Canada |
|subdivision_type1 = [[Provinces and territories of Canada|Province]] | |subdivision_type1 = [[Provinces and territories of Canada|Province]] | ||
|subdivision_name1 = [[Ontario]] | |subdivision_name1 = [[Ontario]] | ||
| Line 47: | Line 72: | ||
|leader_name = [[Fred Eisenberger]] | |leader_name = [[Fred Eisenberger]] | ||
|leader_title1 = [[City Council]] | |leader_title1 = [[City Council]] | ||
| − | |leader_name1 = [[Hamilton, Ontario City Council]] | + | |leader_name1 = [[Hamilton, Ontario, City Council]] |
|leader_title2 = [[Member of Parliament#Canada|MPs]] | |leader_title2 = [[Member of Parliament#Canada|MPs]] | ||
|leader_name2 = | |leader_name2 = | ||
| Line 64: | Line 89: | ||
|established_title = [[Municipal corporation|Incorporated]] | |established_title = [[Municipal corporation|Incorporated]] | ||
|established_date = June 9, 1846 | |established_date = June 9, 1846 | ||
| + | |short_description = | ||
}} | }} | ||
| − | < | + | <syntaxhighlight lang="html" style="font-size:95%; overflow:auto;"> |
{{Infobox settlement | {{Infobox settlement | ||
|official_name = City of Hamilton | |official_name = City of Hamilton | ||
| − | ...truncated... | + | ...truncated... |
|leader_title = [[Mayor]] | |leader_title = [[Mayor]] | ||
|leader_name = [[Fred Eisenberger]] | |leader_name = [[Fred Eisenberger]] | ||
| Line 91: | Line 117: | ||
(...etc...) | (...etc...) | ||
}} | }} | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | == TemplateData == | ||
| + | {{TemplateDataHeader}} | ||
| + | <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> | ||
| − | <includeonly>{{ | + | <includeonly>{{Sandbox other|| |
[[Category:Collapse templates]] | [[Category:Collapse templates]] | ||
| − | [[Category:List | + | [[Category:List formatting and function templates]] |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
}}</includeonly> | }}</includeonly> | ||
Latest revision as of 12:00, 7 July 2020
| This is a documentation subpage for Template:Collapsible list. It contains 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 |
|---|
| Script error: No such module "aligned table". |
| Article namespace |
|
| Infoboxes |
| Navigation templates |
| Talk namespace |
|
Contents
Syntax
{{Collapsible list
| expand =
| framestyle =
| titlestyle =
| title =
| liststyle =
| hlist =
| bullets =
| 1 = <!--(First item in list; the "1 =" is usually not required)-->
| 2 = <!--(Second item in list; ditto)-->
| 3 = <!--(Third item in list; etc.)-->
| <!-- etc -->
}}
Parameters
Script error: No such module "aligned table".
Examples
{{Collapsible list
| title = [[European Free Trade Association]] members
| [[Iceland]]
| [[Liechtenstein]]
| [[Norway]]
| [[Switzerland]]
}}
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.
[[Category:Template:Pagetype with short description]]
Script error: No such module "If empty". | |
|---|---|
| Motto(s): Script error: No such module "If empty". | |
| Country | Canada |
| Province | Ontario |
| Incorporated | June 9, 1846 |
| Government | |
| • Mayor | Fred Eisenberger |
| • City Council | Hamilton, Ontario, City Council |
| • MPs | |
| • MPPs | |
| Script error: No such module "If empty". | |
| Script error: No such module "If empty". | |
{{Infobox settlement
|official_name = City of Hamilton
...truncated...
|leader_title = [[Mayor]]
|leader_name = [[Fred Eisenberger]]
|leader_title1 = [[City Council]]
|leader_name1 = [[Hamilton City Council]]
|leader_title2 = [[Member of Parliament (Canada)|MPs]]
|leader_name2 =
{{Collapsible list
|framestyle=border:none; padding:0; <!--Hides borders and improves row spacing-->
|title=List of MPs
|1=[[Dean Allison]] |2=[[Chris Charlton]] |3=[[David Christopherson]] |4=[[Wayne Marston]] |5=[[David Sweet]]
}}
|leader_title3 = [[Member of Provincial Parliament (Ontario)|MPPs]]
|leader_name3 =
{{Collapsible list
|framestyle=border:none; padding:0; <!--as above-->
|title=List of MPPs
|1=[[Marie Bountrogianni]] |2=[[Andrea Horwath]] |3=[[Judy Marsales]] |4=[[Ted McMeekin]] |5=[[Jennifer Mossop]]
}}
|established_title = [[Municipal corporation|Incorporated]]
|established_date = June 9, 1846
(...etc...)
}}
TemplateData
TemplateData for Collapsible list
Produces an HTML list that can be collapsed
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Title | title | The list's title (Always in view beside the list's [show/hide] link). | String | suggested |
| Horizontal list | hlist | Use value 'on' or 'true' to produce a horizontal rather than vertical list
| String | optional |
| Bullets | bullets | Set as 'on' or 'true' to place a bullet point before each list item
| String | optional |
| Expand list | expand | Expand the list instead of collapsing it
| String | optional |
| First list item | 1 | A single list item | Content | suggested |
| Frame style | framestyle frame_style | Custom CSS styling applied the template overall (title and list).
| String | optional |
| Title style | titlestyle title_style | CSS styling applied to the title
| String | optional |
| List style | liststyle list_style | CSS styling applied solely to the list itself
| String | optional |
| Second list item | 2 | A single list item | Content | suggested |
| Third list item | 3 | A single list item | Content | suggested |
| Fourth list item | 4 | A single list item | Content | optional |
| 5 | 5 | no description | Content | optional |
| 6 | 6 | no description | Content | optional |
| 7 | 7 | no description | Content | optional |
| 8 | 8 | no description | Content | optional |
| 9 | 9 | no description | Content | optional |
| 10 | 10 | no description | Content | optional |