Template:Collapsible list/doc

From Osolia Wiki
Revision as of 18:55, 5 December 2024 by TheRandomMelon (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

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 an exception: 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.

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

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

{{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.

City of Hamilton
File:HamiltonOntarioSkylineC.JPG
Motto: 
Together Aspire – Together Achieve
CountryCanada
ProvinceOntario
IncorporatedJune 9, 1846
Government
 • MayorFred Eisenberger
 • City CouncilHamilton, Ontario, City Council
 • MPs
 • MPPs
{{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

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Collapsible list in articles based on its TemplateData.

TemplateData for Collapsible list

Produces an HTML list that can be collapsed

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titletitle

The list's title (Always in view beside the list's [show/hide] link).

Stringsuggested
Horizontal listhlist

Use value 'on' or 'true' to produce a horizontal rather than vertical list

Suggested values
on true
Example
true
Auto value
true
Stringoptional
Bulletsbullets

Set as 'on' or 'true' to place a bullet point before each list item

Example
true
Auto value
true
Stringoptional
Expand listexpand

Expand the list instead of collapsing it

Suggested values
true
Example
true
Auto value
true
Stringoptional
First list item1

A single list item

Contentsuggested
Frame styleframestyle frame_style

Custom CSS styling applied the template overall (title and list).

Example
border: 1px;
Stringoptional
Title styletitlestyle title_style

CSS styling applied to the title

Example
color:brown;
Stringoptional
List styleliststyle list_style

CSS styling applied solely to the list itself

Example
list-style-type: square;
Stringoptional
Second list item2

A single list item

Contentsuggested
Third list item3

A single list item

Contentsuggested
Fourth list item4

A single list item

Contentoptional
Fifth list item5

A single list item

Contentoptional
Sixth list item6

A single list item

Contentoptional
Seventh list item7

A single list item

Contentoptional
Eighth list item8

A single list item

Contentoptional
Ninth list item9

A single list item

Contentoptional
Tenth list item10

A single list item

Contentoptional