![]() | This template is used in MediaWiki:Protect-text, and on approximately 53,000 pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. Preview message: Transclusion count updated automatically (see documentation). |
The {{collapse top}}
template (or {{cot}}
), and its paired template {{collapse bottom}}
(or {{cob}}
), are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables. For very simple content, the one-piece template {{collapse}}
can be used instead.
![]() | These templates don't work properly when you are using the Reply Tool. Specifically, any text after the collapsible box disappears. This is because the Reply Tool inserts indentation colons (: ) to each line of your response, and {{collapse bottom}} needs to be placed on its own line, with no characters preceding it on that line. One simple workaround: post your reply anyway, then edit your post to remove the erring colon, and the template will start to work. |
This template should only be used by uninvolved editors in conjunction with the talk page guidelines and relevant advice at WP:Refactoring. It should not be used by involved parties to end a discussion over the objections of other editors. See WP:SUPERHAT.
Do not hide content in articles. This violates the Wikipedia:Manual of Style § Scrolling lists and collapsible content and Wikipedia:Accessibility guidelines.
Place {{collapse top}}
(or {{cot}}
), and {{collapse bottom}}
(or {{cob}}
), around the text to be collapsed. For example:
{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}
produces:
This is the title text
|
---|
Sample contents text |
{{collapse bottom}}
should always be placed on its own line. Do not place any characters before the template on this line. This means that if you use the Reply Tool, you need to remember to manually remove the colon (:
) or colons it inserts at the start of each line to maintain proper indentation after replying.
The entirety of {{collapse bottom}}
that is transcluded |}</div>
to easily keep track of which template concludes which collapsed block when editing a page's source.
This template takes the following parameters, all of which are optional. They are case-sensitive. Those that take CSS measurements require them in CSS format (e.g. 1em
, not 1 em
).
|1=
, |title=
, |reason=
, |header=
, |heading=
, |result=
, or first unnamed parameter{{collapse top|title=This is the title text}}
or {{collapse top|This is the title text}}
. Note: The shorter, unnamed markup will not work if the title value contain an equals (=
) character.|warning=yes
|warning=no
will not work as expected).|2=
or second unnamed parameter|warning=yes
in this case, though doing so is harmless.|left=yes
|left=no
will not work as expected); nor is there a |right=
parameter.|expand=yes
or |collapse=no
|expand=no
and |collapse=yes
will not work as expected).|bg=
#CCFFCC
, a green hue. Named colors are listed at List of colors. For example, {{collapse top|This is the title text|bg=#F0F2F5}}
or {{collapse top|This is the title text|bg=LightGrey}}
(HTML hex color codes require the leading #
).|fc=
|bg=
, above, for details on color options.|border=
1px
. For example, {{collapse top|border=2px}}
; going much thicker than this is not very useful.|b-color=
Silver
(#C0C0C0
). See |bg=
, above, for details on color options.|padding=
0.6em
.|width=
|width=50%
, or in relative em units, e.g. |width=30em
. Pixel-based values should be avoided, as they are effectively meaningless – the result will be different depending on each user's browser and local CSS settings (which browser and operating system it is, zoom level, font sizes, etc.).|border2=
1px Silver
(there is no provision to change from a solid line). For example, {{collapse top|border2=2px}}
(only width or color will be changed if only one value is supplied). See |bg=
, above, for details on color options.|bg2=
White
(#FFFFFF
). See |bg=
, above, for details on color options.|indent=
:
in talk page markup is approximately equivalent to 1.6em
of indent (e.g., to match ::::
indentation level, use |indent=6.4em
). You can also use a percentage value. Pixel-based values should be avoided (see |width=
, above, for why).|clear=
clear: both;
CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use |clear=none
, |clear=right
, or |clear=left
, as needed.{{collapse top|This is the title text}}
This is the title text
|
---|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top|This is the title text|warning=true}}
This is the title text
|
---|
The following is a closed discussion. Please do not modify it. |
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top|This is the title text|This is a custom warning line}}
This is the title text
|
---|
This is a custom warning line |
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top|left=true}}
Extended content
|
---|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top|bg=#F0F2F5}}
Extended content
|
---|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top|padding=5em}}
Extended content
|
---|
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. |
{{collapse top}}
==Section header==
Sample contents text
{{collapse bottom}}
must be rewritten as:
{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}
The end result:
Section header
|
---|
Sample contents text |
TemplateData for Collapse bottom
Use in conjunction with {{Collapse bottom}}. Will collapse text in between the two templates.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Title | 1 title heading header reason result | Main title of collapsed box
| Line | optional |
Custom warning line | 2 | Will override the standard warning line, and make the 'warning' parameter unnecessary
| String | optional |
Indent (px or em) | indent | Indents the box from the left of the page
| Unknown | optional |
expand | expand collapse | Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring
| String | optional |
Border width (px) | border | Sets the width of the border line on the collapsed material
| Unknown | optional |
Border color | b-color | Sets the border color
| Unknown | optional |
Template width (% or em) | width | Sets the width of the overall template
| Unknown | optional |
Collapsed material background color | bg | Sets the background color of the collapsed material
| Unknown | optional |
Alight along the left margin (true or blank) | left | Will align the 'parameter 1 title' along the left margin
| String | optional |
Title font color | fc | Sets the font color of the title of the collapsible bar
| Unknown | optional |
Warning (true or blank) | warning | Will display a default warning line under the main title which reads "The following is a closed debate. Please do not modify it."
| Unknown | optional |
Expanded box border size & color | border2 | Sets the border of the box that appears when template is expanded
| Unknown | optional |
Padding (px) | padding | Sets the padding on the collapsed material in the colored area
| Unknown | optional |
Expanded box color | bg2 | Sets background of the box that appears when template is expanded
| Unknown | optional |
To Collapse top:
To Collapse bottom: