m sp:inherent not inherit |
Dipsacus fullonum (talk | contribs) Remove outdated no longer valid text from 2008 about customization |
||
(128 intermediate revisions by 79 users not shown) | |||
Line 1: | Line 1: | ||
{{Short description|Wikipedia project page}} |
|||
'''Collapsible tables''' are an alternative to [[Wikipedia:NavFrame]]s they're easier to use and implement, but are not accessibility friendly due to their inherent table nature. Code is found in the [[MediaWiki:Common.js]] and is actively maintained by [[User:R. Koot]]. |
|||
{{About|how to collapse content when editing Wikipedia pages|the Manual of Style on collapsing content|MOS:COLLAPSE}} |
|||
{{Wikipedia how-to|H:COLS}} |
|||
A '''collapsible''' element contains a toggle a reader can use to show or hide the element's content. Elements are made collapsible by adding the <code>mw-collapsible</code> class, or alternatively by using the {{tlx|Collapse}} template, or its variants {{tlx|Collapse top}} and {{tlx|Collapse bottom}}. |
|||
Use of these features in article content is governed by the guidelines {{section link|Wikipedia:Manual of Style#Scrolling lists and collapsible content}} generally, and more specifically by [[Wikipedia:Spoiler]]. |
|||
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. |
|||
==Collapsible tables== |
|||
====Simple example==== |
|||
The <code>[[mw:Manual:Collapsible elements|mw-collapsible]]</code> class can make any element collapsible, but tables are particularly simple to make collapsible. Adding the <code>mw-collapsible</code> class to a table automatically positions the toggle, and selects which parts to collapse. |
|||
Tables are simpler to work with, as you merely need to add the '''<code>collapsible</code>''' to the table itself. For the [hide]/[show] link to appear, the table's first row must be a header row, i.e. begin (in wikisyntax) with an exclamation mark. The use of the class <code>toccolours</code> in the example below is merely for appearance; it is not needed for <code>collapsible</code> to function: |
|||
<pre> |
|||
A common use is to make a collapsible layout table, which always displays an introduction or summary, but hides the rest of the content from immediate view. The introduction or summary is in the first row, and the content is in subsequent rows. The content is then easily accessible by using the 'show' button. |
|||
{| class="toccolours collapsible" width="60%" |
|||
!colspan="2"| Fun with table columns |
|||
In the examples below, the use of the class <code>wikitable</code> is merely for appearance; it is not needed for <code>mw-collapsible</code> to function. |
|||
{| class=wikitable style="width:80%;" |
|||
!Code entered!!Output produced |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
| Column 1 || Column 2 |
|||
<syntaxhighlight lang="wikitext">{| role="presentation" class="wikitable mw-collapsible" |
|||
|} |
|||
| <strong>Lorem ipsum</strong> |
|||
</pre> |
|||
{| class="toccolours collapsible" width="60%" |
|||
!colspan="2"| Fun with table columns |
|||
|- |
|- |
||
| Lorem ipsum dolor sit amet |
|||
| Column 1 || Column 2 |
|||
|}</syntaxhighlight> |
|||
|style="width:50%;"| |
|||
{| role="presentation" class="wikitable mw-collapsible" |
|||
| <strong>Lorem ipsum</strong> |
|||
|- |
|||
| Lorem ipsum dolor sit amet |
|||
|} |
|} |
||
|} |
|||
More complex data tables can also be collapsible. |
|||
{| class="wikitable" style="width:80%;" |
|||
==== One-element example, initially expanded ==== |
|||
!Code entered!!Output produced |
|||
<pre> |
|||
{| class="collapsible" |
|||
!Always displayed header |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
|Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text |
|||
<syntaxhighlight lang="wikitext"> |
|||
{| class="wikitable mw-collapsible" |
|||
|+ class="nowrap" | Winter Olympic Games |
|||
|- |
|||
| |
|||
! scope="col" | City |
|||
! scope="col" | Country |
|||
|- |
|||
! scope="row" | 1994 |
|||
| Lillehammer || Norway |
|||
|- |
|||
! scope="row" | 1998 |
|||
| Nagano || Japan |
|||
|} |
|} |
||
</syntaxhighlight> |
|||
</pre> |
|||
|style="width:50%;"| |
|||
{| class="collapsible" |
|||
{| class="wikitable mw-collapsible" |
|||
!Always displayed header |
|||
|+ class="nowrap" | Winter Olympic Games |
|||
|- |
|- |
||
| |
|||
|Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text |
|||
! scope="col" | City |
|||
! scope="col" | Country |
|||
|- |
|||
! scope="row" | 1994 |
|||
| Lillehammer || Norway |
|||
|- |
|||
! scope="row" | 1998 |
|||
| Nagano || Japan |
|||
|} |
|} |
||
|} |
|||
==Collapsing by default== |
|||
Just using the <code>mw-collapsible</code> class leaves the element expanded by default, but it can be collapsed by the reader. It is also possible to make the element collapsed by default, and optionally expanded by adding other classes along with <code>mw-collapsible</code>. There are several methods for doing this, depending on the situations in which you want the element to collapse. However, content should not be collapsed by default per [[MOS:DONTHIDE]]. |
|||
==="mw-collapsed"=== |
|||
Adding the <code>mw-collapsed</code> class will cause the element to {{em|always}} be initially collapsed, no matter what happens around it. It is the simplest method for doing so. Using the examples above: |
|||
{| class=wikitable style="width:80%;" align=center |
|||
====Auto-collapsing tables==== |
|||
!Code entered!!Output produced |
|||
You have two choices of auto-collapse. In addition to the <code>collapsible</code> class, you can add either '''<code>collapsed</code>''' or '''<code>autocollapse</code>'''. The first always initially collapses a table. <code>autocollapse</code> only initially collapses a table if there are at least two collapsible tables on a page. |
|||
<pre>{| class="toccolours collapsible autocollapse" width=60% |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
! colspan="2" | This autocollapse table will initially collapse because there are at least two collapsible tables on this page. |
|||
<syntaxhighlight lang="wikitext">{| role="presentation" class="wikitable mw-collapsible mw-collapsed" |
|||
| <strong>Lorem ipsum</strong> |
|||
|- |
|- |
||
| Lorem ipsum dolor sit amet |
|||
| Column 1 || Column 2 |
|||
|}</ |
|}</syntaxhighlight> |
||
|style="width:50%;"| |
|||
{| class="toccolours collapsible autocollapse" width=60% |
|||
{| role="presentation" class="wikitable mw-collapsible mw-collapsed" |
|||
| <strong>Lorem ipsum</strong> |
|||
|- |
|- |
||
| Lorem ipsum dolor sit amet |
|||
! colspan="2" | This autocollapse table will initially collapse because there are at least two collapsible tables on this page. |
|||
|} |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
| Column 1 || Column 2 |
|||
<syntaxhighlight lang="wikitext"> |
|||
{| class="wikitable mw-collapsible mw-collapsed" |
|||
|+ class="nowrap" | Winter Olympic Games |
|||
|- |
|||
| |
|||
! scope="col" | City |
|||
! scope="col" | Country |
|||
|- |
|||
! scope="row" | 1994 |
|||
| Lillehammer || Norway |
|||
|- |
|||
! scope="row" | 1998 |
|||
| Nagano || Japan |
|||
|} |
|} |
||
</syntaxhighlight> |
|||
|style="width:50%;"| |
|||
{| class="wikitable mw-collapsible mw-collapsed" |
|||
|+ class="nowrap" | Winter Olympic Games |
|||
|- |
|||
| |
|||
! scope="col" | City |
|||
! scope="col" | Country |
|||
|- |
|||
! scope="row" | 1994 |
|||
| Lillehammer || Norway |
|||
|- |
|||
! scope="row" | 1998 |
|||
| Nagano || Japan |
|||
|} |
|||
|} |
|||
==="autocollapse"=== |
|||
{{hatnote|Using this technique causes the page to reflow/jump around and should generally be avoided.}} |
|||
Adding the <code>autocollapse</code> class causes an element to collapse if there are 2 or more collapsible elements on the page. The example below, therefore, collapses because there are numerous collapsible elements on this page. |
|||
{| class=wikitable style="width:80%;" align=center |
|||
!Code entered!!Output produced |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
! colspan="2" | This table will always initially collapse |
|||
<syntaxhighlight lang="wikitext">{| role="presentation" class="wikitable mw-collapsible autocollapse" |
|||
| <strong>Lorem ipsum</strong> |
|||
|- |
|- |
||
| Lorem ipsum dolor sit amet |
|||
| Column 1 || Column 2 |
|||
|}</ |
|}</syntaxhighlight> |
||
|style="width:50%;"| |
|||
{| class="toccolours collapsible collapsed" width=60% |
|||
{| role="presentation" class="wikitable mw-collapsible autocollapse" |
|||
| <strong>Lorem ipsum</strong> |
|||
|- |
|- |
||
| Lorem ipsum dolor sit amet |
|||
! colspan="2" | This table will always initially collapse |
|||
|} |
|||
|} |
|||
==="innercollapse" and "outercollapse"=== |
|||
{{hatnote|Using this technique causes the page to reflow/jump around and should generally be avoided.}} |
|||
Using this pair of classes, it is possible to make an element collapsed by default only when it is {{em|contained within}} a particular outer element. An element with the <code>mw-collapsible</code> and <code>innercollapse</code> classes is collapsed by default if it is contained within an element with the <code>outercollapse</code> class; otherwise, it is uncollapsed by default. This is mainly useful for templates, which are often nested. |
|||
{| class=wikitable style="width:80%;" align=center |
|||
!Code entered!!Output produced |
|||
|- |
|- |
||
|style="width:50%;"| |
|||
| Column 1 || Column 2 |
|||
<syntaxhighlight lang="wikitext"> |
|||
{| role="presentation" class="wikitable mw-collapsible innercollapse" |
|||
| This <code>innercollapse</code> element is |
|||
|- |
|||
| <em>uncollapsed</em> by default |
|||
|} |
|} |
||
<div class="wikitable outercollapse" style="padding:1em; background:#ccc;"> |
|||
One-element example, initially collapsed: |
|||
This is an element with the <code>outercollapse</code> class. |
|||
{| class="collapsible collapsed" |
|||
!Always displayed header |
|||
{| role="presentation" class="wikitable mw-collapsible innercollapse" |
|||
| This <code>innercollapse</code> element is |
|||
|- |
|- |
||
| <em>collapsed</em> by default |
|||
|Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text Optionally displayed text |
|||
|} |
|||
</div> |
|||
</syntaxhighlight> |
|||
|style="width:50%;"| |
|||
{| role="presentation" class="wikitable mw-collapsible innercollapse" |
|||
| This <code>innercollapse</code> element is |
|||
|- |
|||
| <em>uncollapsed</em> by default |
|||
|} |
|} |
||
<div class="wikitable outercollapse" style="padding:1em; background:#ccc;"> |
|||
====Sortable collapsible tables==== |
|||
This is an element with the <code>outercollapse</code> class. |
|||
{| |
|||
!initially expanded!!initially collapsed |
|||
{| role="presentation" class="wikitable mw-collapsible innercollapse" |
|||
| This <code>innercollapse</code> element is |
|||
|- |
|- |
||
| <em>collapsed</em> by default |
|||
| |
|||
|} |
|||
{|class="collapsible" |
|||
</div> |
|||
!numbers |
|||
|} |
|||
==Other notes== |
|||
===Tables with captions=== |
|||
A table without a caption will collapse to its first row. A table <em>with</em> a caption will collapse to its caption, with no rows, therefore no width. Use <code>class="nowrap"</code> or {{tlx|nowrap}} to keep the caption from being squeezed into a vertical column when the table is collapsed. |
|||
{|class="wikitable" style="margin:0.5em auto;width:80%" |
|||
|- |
|- |
||
!scope="col" width="60%"|Code entered |
|||
| |
|||
!scope="col" width="40%"|Output produced |
|||
{|class="wikitable sortable" |
|||
!name!!number |
|||
|- |
|- |
||
|width="60%"| |
|||
|a||123 |
|||
<syntaxhighlight lang="wikitext">{|class="wikitable sortable mw-collapsible" |
|||
|+ class="nowrap" | Somewhat long table caption |
|||
! Name !! Score |
|||
|- |
|- |
||
| |
| John || 59 |
||
|- |
|- |
||
| |
| Bob || 72 |
||
|}</syntaxhighlight> |
|||
|width="40%"| |
|||
{|class="wikitable sortable mw-collapsible" |
|||
|+ class="nowrap" | Somewhat long table caption |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|} |
|} |
||
|} |
|} |
||
| |
|||
Next example uses '''{{tlx|nowrap}}''' where the end brackets become the wrap point. '''<code><style=max-width:Xem;</code>''' will not work. |
|||
{|class="collapsible collapsed" |
|||
!numbers |
|||
{|class="wikitable" style="margin:0.5em auto;width:80%" |
|||
|- |
|- |
||
!scope="col" width="60%"|Code entered |
|||
| |
|||
!scope="col" width="40%"|Output produced |
|||
{|class="wikitable sortable" |
|||
!name!!number |
|||
|- |
|- |
||
|width="60%"| |
|||
|a||123 |
|||
<syntaxhighlight lang="wikitext">{|class="wikitable sortable mw-collapsible" |
|||
|+ {{nowrap|A longer table caption needs to wrap}} for cell phones, etc. |
|||
! Name !! Score |
|||
|- |
|- |
||
| |
| John || 59 |
||
|- |
|- |
||
| |
| Bob || 72 |
||
|}</syntaxhighlight> |
|||
|width="40%"| |
|||
{|class="wikitable sortable mw-collapsible" |
|||
|+ {{nowrap|A longer table caption needs to wrap}} for cell phones, etc. |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|} |
|} |
||
|} |
|||
===Sortable tables=== |
|||
Collapsible tables can be combined with the [[Help:Sorting|sortable tables]] functionality without difficulty. However, because the hide/show button is placed with <code><!--Do not write mw- here-->collapsible</code> in the first header cell located or with <code>mw-collapsible</code> in the right header cell (this difference [[Talk:List of highest-grossing films#Franchise table|may change]]), its positioning can look a bit peculiar if the cell is not wide enough: |
|||
{|class="wikitable" style="margin:0.5em auto;width:80%" |
|||
|- |
|||
!scope="col" width="60%"|Code entered |
|||
!scope="col" width="40%"|Output produced |
|||
|- |
|||
|width="60%"| |
|||
<syntaxhighlight lang="wikitext">{|class="wikitable mw-collapsible sortable" style="width:5em" |
|||
<!--table width too narrow, on purpose here--> |
|||
|- |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|}</syntaxhighlight> |
|||
|width="40%"| |
|||
{|class="wikitable sortable mw-collapsible" style="width:5em" |
|||
<!--table width too narrow, on purpose here--> |
|||
|- |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|} |
|} |
||
|} |
|} |
||
A possible alternative is to add a caption over the table. See the following example. |
|||
{|class="wikitable" style="margin:0.5em auto;width:80%" |
|||
|- |
|||
!scope="col" width="60%"|Code entered |
|||
!scope="col" width="40%"|Output produced |
|||
|- |
|||
|width="60%"| |
|||
<syntaxhighlight lang="wikitext">{|class="wikitable sortable mw-collapsible" |
|||
|+ class="nowrap" | Caption |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|}</syntaxhighlight> |
|||
|width="40%"| |
|||
{|class="wikitable sortable mw-collapsible" |
|||
|+ class="nowrap" | Caption |
|||
! Name !! Score |
|||
|- |
|||
| John || 59 |
|||
|- |
|||
| Bob || 72 |
|||
|} |
|||
|} |
|||
===Limitations=== |
|||
<!--The content of this section is transcluded at [[Template:Collapse top/doc#Limitations]] and [[Template:Collapse/doc#Limitations]].--> |
|||
* This functionality requires the end-user's browser to have [[JavaScript]] enabled. If JavaScript is disabled, the default behaviour is to show the content. |
|||
* It doesn't work on mobile browsers (or desktop browsers in mobile mode) either. |
|||
==See also== |
==See also== |
||
Documentation: |
|||
*{{mlm|Help:Collapsing}} |
|||
* {{Section link|Wikipedia:Manual of Style|Scrolling lists and collapsible content}} – style guidelines for collapsing content |
|||
* [[Help:Table]] |
|||
* [[Help:Table of contents]] |
|||
Templates: |
|||
* {{Tl|Collapse}} |
|||
* {{Tl|Collapse-top}} and {{Tl|Collapse-bottom}} – more feature-rich than {{Tlf|collapse}} |
|||
* {{Tl|Hidden}} |
|||
* {{Tl|Navbar-collapsible}} |
|||
== External links == |
|||
*[[mw:Manual:Collapsible elements]] |
|||
*[[mw:ResourceLoader/Default modules#jquery.makeCollapsible]] |
|||
{{Wikipedia technical help|collapsed}} |
|||
[[Category:Navigational templates]] |
|||
[[Category:Wikipedia how-to]] |
|||
[[Category:Wikipedia tables]] |
Latest revision as of 15:38, 9 May 2024
A collapsible element contains a toggle a reader can use to show or hide the element's content. Elements are made collapsible by adding the mw-collapsible
class, or alternatively by using the {{Collapse}}
template, or its variants {{Collapse top}}
and {{Collapse bottom}}
.
Use of these features in article content is governed by the guidelines Wikipedia:Manual of Style § Scrolling lists and collapsible content generally, and more specifically by Wikipedia:Spoiler.
Collapsible tables
The mw-collapsible
class can make any element collapsible, but tables are particularly simple to make collapsible. Adding the mw-collapsible
class to a table automatically positions the toggle, and selects which parts to collapse.
A common use is to make a collapsible layout table, which always displays an introduction or summary, but hides the rest of the content from immediate view. The introduction or summary is in the first row, and the content is in subsequent rows. The content is then easily accessible by using the 'show' button.
In the examples below, the use of the class wikitable
is merely for appearance; it is not needed for mw-collapsible
to function.
Code entered | Output produced | ||
---|---|---|---|
{| role="presentation" class="wikitable mw-collapsible"
| <strong>Lorem ipsum</strong>
|-
| Lorem ipsum dolor sit amet
|}
|
|
More complex data tables can also be collapsible.
Code entered | Output produced | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
{| class="wikitable mw-collapsible"
|+ class="nowrap" | Winter Olympic Games
|-
|
! scope="col" | City
! scope="col" | Country
|-
! scope="row" | 1994
| Lillehammer || Norway
|-
! scope="row" | 1998
| Nagano || Japan
|}
|
|
Collapsing by default
Just using the mw-collapsible
class leaves the element expanded by default, but it can be collapsed by the reader. It is also possible to make the element collapsed by default, and optionally expanded by adding other classes along with mw-collapsible
. There are several methods for doing this, depending on the situations in which you want the element to collapse. However, content should not be collapsed by default per MOS:DONTHIDE.
"mw-collapsed"
Adding the mw-collapsed
class will cause the element to always be initially collapsed, no matter what happens around it. It is the simplest method for doing so. Using the examples above:
Code entered | Output produced | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
{| role="presentation" class="wikitable mw-collapsible mw-collapsed"
| <strong>Lorem ipsum</strong>
|-
| Lorem ipsum dolor sit amet
|}
|
| |||||||||
{| class="wikitable mw-collapsible mw-collapsed"
|+ class="nowrap" | Winter Olympic Games
|-
|
! scope="col" | City
! scope="col" | Country
|-
! scope="row" | 1994
| Lillehammer || Norway
|-
! scope="row" | 1998
| Nagano || Japan
|}
|
|
"autocollapse"
Adding the autocollapse
class causes an element to collapse if there are 2 or more collapsible elements on the page. The example below, therefore, collapses because there are numerous collapsible elements on this page.
Code entered | Output produced | ||
---|---|---|---|
{| role="presentation" class="wikitable mw-collapsible autocollapse"
| <strong>Lorem ipsum</strong>
|-
| Lorem ipsum dolor sit amet
|}
|
|
"innercollapse" and "outercollapse"
Using this pair of classes, it is possible to make an element collapsed by default only when it is contained within a particular outer element. An element with the mw-collapsible
and innercollapse
classes is collapsed by default if it is contained within an element with the outercollapse
class; otherwise, it is uncollapsed by default. This is mainly useful for templates, which are often nested.
Code entered | Output produced | ||||
---|---|---|---|---|---|
{| role="presentation" class="wikitable mw-collapsible innercollapse"
| This <code>innercollapse</code> element is
|-
| <em>uncollapsed</em> by default
|}
<div class="wikitable outercollapse" style="padding:1em; background:#ccc;">
This is an element with the <code>outercollapse</code> class.
{| role="presentation" class="wikitable mw-collapsible innercollapse"
| This <code>innercollapse</code> element is
|-
| <em>collapsed</em> by default
|}
</div>
|
This is an element with the
|
Other notes
A table without a caption will collapse to its first row. A table with a caption will collapse to its caption, with no rows, therefore no width. Use class="nowrap"
or {{nowrap}}
to keep the caption from being squeezed into a vertical column when the table is collapsed.
Code entered | Output produced | ||||||
---|---|---|---|---|---|---|---|
{|class="wikitable sortable mw-collapsible"
|+ class="nowrap" | Somewhat long table caption
! Name !! Score
|-
| John || 59
|-
| Bob || 72
|}
|
|
Next example uses {{nowrap}}
where the end brackets become the wrap point. <style=max-width:Xem;
will not work.
Code entered | Output produced | ||||||
---|---|---|---|---|---|---|---|
{|class="wikitable sortable mw-collapsible"
|+ {{nowrap|A longer table caption needs to wrap}} for cell phones, etc.
! Name !! Score
|-
| John || 59
|-
| Bob || 72
|}
|
|
Sortable tables
Collapsible tables can be combined with the sortable tables functionality without difficulty. However, because the hide/show button is placed with collapsible
in the first header cell located or with mw-collapsible
in the right header cell (this difference may change), its positioning can look a bit peculiar if the cell is not wide enough:
Code entered | Output produced | ||||||
---|---|---|---|---|---|---|---|
{|class="wikitable mw-collapsible sortable" style="width:5em"
<!--table width too narrow, on purpose here-->
|-
! Name !! Score
|-
| John || 59
|-
| Bob || 72
|}
|
|
A possible alternative is to add a caption over the table. See the following example.
Code entered | Output produced | ||||||
---|---|---|---|---|---|---|---|
{|class="wikitable sortable mw-collapsible"
|+ class="nowrap" | Caption
! Name !! Score
|-
| John || 59
|-
| Bob || 72
|}
|
|
Limitations
- This functionality requires the end-user's browser to have JavaScript enabled. If JavaScript is disabled, the default behaviour is to show the content.
- It doesn't work on mobile browsers (or desktop browsers in mobile mode) either.
See also
Documentation:
- Wikipedia:Manual of Style § Scrolling lists and collapsible content – style guidelines for collapsing content
- Help:Table
- Help:Table of contents
Templates:
- {{Collapse}}
- {{Collapse-top}} and {{Collapse-bottom}} – more feature-rich than {{collapse}}
- {{Hidden}}
- {{Navbar-collapsible}}