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

From blackwiki
Jump to navigation Jump to search
imported>Jonesey95
(Clarify "expand=" parameter behavior, which is bizarre. See talk page discussion from 2015.)
imported>TheDJ
Line 115: Line 115:
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
== 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>{{#ifeq:{{SUBPAGENAME}}|sandbox||

Revision as of 20:46, 7 June 2018

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.

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's 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".
250px
Motto(s): 
Script error: No such module "If empty".
Location in the province of Ontario, Canada
Location in the province of Ontario, Canada
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

Syntax error in JSON.