Difference between revisions of "Template:Collapsible list/doc"

From blackwiki
Jump to navigation Jump to search
imported>Tahir mq
imported>WOSlinker
m (change source to syntaxhighlight)
 
(33 intermediate revisions by 21 users not shown)
Line 1: Line 1:
{{documentation subpage}}
+
{{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 ==
<pre style="font-size:95%; overflow:auto;">
+
<syntaxhighlight lang="html" style="font-size:95%;overflow:auto;">
 
{{Collapsible list
 
{{Collapsible list
|framestyle = <!--(optional)-->
+
| expand =
|title =  
+
| framestyle =  
|titlestyle = <!--(optional)-->
+
| titlestyle =
|liststyle = <!--(optional)-->
+
| title =  
|1 =         <!--(First item in list)--->
+
| liststyle =  
|2 =         <!--(Second item in list)-->
+
| hlist =
|3 =         <!--(Third item in list)--->
+
  | 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 -->
 
}}
 
}}
</pre>
+
</syntaxhighlight>
  
;Default state
+
== Parameters ==
Specifying <code>expand = true</code>, or any non-blank value, will set the default state to expanded.
+
{{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 ==
<pre style="font-size:95%; overflow:auto;">
+
<syntaxhighlight lang="Moin" style="font-size:95%;overflow:auto;">
{{Collapsible list  
+
{{Collapsible list
|title=[[European Free Trade Association]] Members
+
| title = [[European Free Trade Association]] members
|[[Iceland]]  
+
| [[Iceland]]
|[[Liechtenstein]]  
+
| [[Liechtenstein]]
|[[Norway]]  
+
| [[Norway]]
|[[Switzerland]]}}
+
| [[Switzerland]]
</pre>
+
}}
{{Collapsible list |title=[[European Free Trade Association]] Members |[[Iceland]] |[[Liechtenstein]] |[[Norway]] |[[Switzerland]]}}
+
</syntaxhighlight>
 +
{{collapsible list |title=[[European Free Trade Association]] members |[[Iceland]] |[[Liechtenstein]] |[[Norway]] |[[Switzerland]]}}
  
===Example of a list without borders because it's within an infobox===
+
=== 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 - Together Achieve
+
|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  = [[Canada]]
+
|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 =
 
}}
 
}}
<pre style="font-size:95%; overflow:auto;">
+
<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...)
 
}}
 
}}
</pre>
+
</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>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+
<includeonly>{{Sandbox other||
 
[[Category:Collapse templates]]
 
[[Category:Collapse templates]]
[[Category:List templates|Collapsible]]
+
[[Category:List formatting and function templates]]
[[Category:Wikipedia list formatting templates]]
 
  
[[af:Sjabloon:Opvoubare lys]]
 
[[ar:قالب:قائمة مخفية]]
 
[[as:সাঁচ:Collapsible list]]
 
[[be:Шаблон:Collapsible list]]
 
[[be-x-old:Шаблён:Згорнуты сьпіс]]
 
[[bg:Шаблон:Collapsible list]]
 
[[bn:টেমপ্লেট:List collapsed]]
 
[[cy:Nodyn:Rhestr i'w dangos]]
 
[[dsb:Pśedłoga:Schowajobna lisćina]]
 
[[et:Mall:Peidetav loend]]
 
[[eo:Ŝablono:Kaŝebla listo]]
 
[[es:Plantilla:Lista desplegable]]
 
[[eu:Txantiloi:Collapsible list]]
 
[[fr:Modèle:Collapsible list]]
 
[[gl:Modelo:Lista despregable]]
 
[[hy:Կաղապար:Collapsible list]]
 
[[hsb:Předłoha:Schowajomna lisćina]]
 
[[ia:Patrono:Collapsible list]]
 
[[ig:Àtụ:Collapsible list/doc]]
 
[[lt:Šablonas:Collapsible list]]
 
[[ja:Template:Collapsible list]]
 
[[ka:თარგი:Collapsible list]]
 
[[ko:틀:목록 축소]]
 
[[lv:Veidne:Collapsible list]]
 
[[map-bms:Cithakan:Collapsible list]]
 
[[mk:Шаблон:Расклопен список]]
 
[[ms:Templat:Collapsible list]]
 
[[mr:साचा:Collapsible list]]
 
[[no:Mal:Sammenleggbar liste]]
 
[[or:ଛାଞ୍ଚ:Collapsible list]]
 
[[pt:Predefinição:Collapsible list]]
 
[[ro:Format:Collapsible list]]
 
[[ru:Шаблон:Collapsible list]]
 
[[sk:Šablóna:Collapsible list]]
 
[[sl:Predloga:Skrčljivi seznam]]
 
[[te:మూస:Collapsible list/doc]]
 
[[sv:Mall:Hopfällbar lista]]
 
[[uk:Шаблон:Collapsible list]]
 
[[ur:سانچہ:List collapsed]]
 
[[vi:Bản mẫu:Collapsible list]]
 
[[zh:Template:Collapsible list]]
 
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 12:00, 7 July 2020

Template:Template shortcuts

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

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.

Template:Tfm/dated

[[Category:Template:Pagetype with short description]]

Script error: No such module "If empty".
HamiltonOntarioSkylineC.JPG
Motto(s): 
Script error: No such module "If empty".
CountryCanada
ProvinceOntario
IncorporatedJune 9, 1846
Government
 • MayorFred Eisenberger
 • City CouncilHamilton, 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

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

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

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

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
55

no description

Contentoptional
66

no description

Contentoptional
77

no description

Contentoptional
88

no description

Contentoptional
99

no description

Contentoptional
1010

no description

Contentoptional