Wikia

Help Wiki

WatchlistRandom pageRecent changes

Help:Collapsing

Talk0
259pages on
this wiki
This functionality may require changes to MediaWiki:Common.js on your wiki.

Collapsible tables provide a way to collapse and uncollapse a table when a show/hide button is clicked. The code for this feature is usually found in the MediaWiki:Common.js (see Help:Collapsing/js_code for Javascript code).

The initial state of any collapsible content can be controlled using a "collapsible table", because it also allows a table with only one element with content, and a header.

Contents

Simple example Edit

Tables are simpler to work with, as you merely need to add the collapsible class to the table itself. For the [hide]/[show] link to appear, the table's first row must be a header row, that is, one of the cells in the first row must be declared with an exclamation mark (in wikisyntax). The use of the class wikitable in the example below is merely for appearance; it is not needed for collapsible to function.

Code enteredOutput produced
{| class="wikitable collapsible"
! Simple collapsible table
|-
| L is real 2041
|}
Simple collapsible table
L is real 2041

Using the syntax above, collapsible tables are often used to always display an introduction to, or summary of, a lengthy discussion or section of content, while hiding the majority of that content from immediate view. The summary message is put in the header cell, and the content is placed into the body cell. The content is then easily accessible by clicking the 'show' button. The collapsible functionality is also available in larger and more complicated tables, as long as there is a header cell in the first row of the table.

Code enteredOutput produced
{| class="wikitable collapsible"
 |A normal cell in the header row
 ! colspan="2"| Header cell spans two cols
 |-
 | colspan="2" | Lorem ipsum dolor sit amet
 | Separate body cell
 |}
A normal cell in the header row Header cell spans two cols
Lorem ipsum dolor sit amet Separate body cell

Collapsing tables by defaultEdit

Just using the collapsible class produces a table which is expanded by default, but can be collapsed by the reader. It is also possible to create tables which are collapsed by default, and can be optionally expanded. There are several methods for doing this, depending on the situations in which you want the table to collapse.

'collapsed'Edit

Adding the collapsed class will cause the table to always be initially collapsed, no matter what happens around it. It is the simplest method for doing so. Using the examples above:

Code enteredOutput produced
{| class="wikitable collapsible collapsed"
! Simple collapsible table
|-
| Lorem ipsum dolor sit amet
|}
{| class="wikitable collapsible collapsed"
 |A normal cell in the header row
 ! colspan="2"| Header cell spans two cols
 |-
 | colspan="2" | Lorem ipsum dolor sit amet
 | Separate body cell
 |}

'autocollapse'Edit

Adding the autocollapse class causes the table to collapse when there are 2 or more collapsible tables on the page (this threshold might be different on other projects). The example below, therefore, collapses because there are numerous collapsible tables on the page.

Code enteredOutput produced
{| class="wikitable collapsible autocollapse"
! Simple collapsible table
|-
| Lorem ipsum dolor sit amet
|}
Simple collapsible table
Lorem ipsum dolor sit amet

'innercollapse' and 'outercollapse'Edit

Using this pair of classes, it is possible to make a table collapsed by default only when it is contained within a particular object, such as another table. This is mainly useful for tables inside templates, which are often nested.

Code enteredOutput produced
{| class="wikitable outercollapse"
! This table does not collapse
|-
| But the table inside this cell

{| class="wikitable collapsible innercollapse"
! Does collapse
|-
| Hiding this part
|}

|}
This table does not collapse
But the table inside this cell
Does collapse
Hiding this part

Other notesEdit

Sortable tablesEdit

Collapsible tables can be combined with the sortable tables functionality without difficulty. However, because the hide/show button is placed in the first header cell located, its positioning can look a bit peculiar if the table is not wide enough:

Code enteredOutput produced
{| class="wikitable collapsible sortable"
!Name!!Score
|-
|John||59
|-
|Jane||100
|-
|Bob||72
|}
NameScore
John59
Jane100
Bob72

Possible alternative is sortable table inside one-cell collapsible table, see example on the right.

Customization Edit

Registered users can edit their personal js file file to change some of the variables used.

autoCollapse = 4 //how many collapsible tables on the page before autocollapse works (default=2)
var collapseCaption = 'collapse' //text of the [hide] link (default='hide')
var expandCaption = 'uncollapse' //text of the [show] link (default='show')

Other HTML elements Edit

The code that performs the manipulation only checks for table elements, so these classes will not work for other elements, such as <div> or <span>. There is a similar feature for use with <div> elements, called "NavFrame". See Wikipedia:NavFrame

Limitations Edit

This functionality requires the end-user's browser to have Javascript enabled. If Javascript is disabled, the default behaviour is to show the content.

See also Edit

External links Edit

Latest Photos

Add a Photo
955photos on this wiki
See more >

Recent Wiki Activity

See more >

Around Wikia's network

Random Wiki