Template:Collapse/doc
 | This is a documentation subpage for Template:Collapse. It contains usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 5,300 pages, so changes to it will be widely noticed. Please test any changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Please consider discussing changes on the talk page before implementing them. |
| Collapsible templates |
|---|
| Basic |
|
| Discussion |
|
| Infobox |
| Navigation |
The {{collapse|folding text}} template is used for placing collapse boxes around short discussions and bits of discussions. To fold long discussion threads, use {{Collapse top}}... lots of text ...{{Collapse bottom}}.
This template should only be used in accordance with the Wikipedia:refactoring guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.
Do not hide content in articles. This violates the WP:Manual of Style#Scrolling lists and collapsible content and WP:Accessibility guidelines.
Contents
Usage
Note: {{Collapse}} needs to be substed in order for the time stamp functionality to work properly.
{{Collapse|1=Discussion text to be put into box.|2=Optional custom heading}}
It is definitely safest to use the named |1= and |2= parameters, because otherwise any "=" character will break the template.
For compatibility with various discussion-boxing and -closing, and discussion-wrapping templates, |1= can also be given as |content= or |text=, and |2= can also be given as |title=, |reason=, |header=, |heading=, or |result=.
The bg parameter
The bg parameter is optional. It changes the background color. Use Web color values (e.g. #F0F2F5).
- Example
{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}} creates:
| Extended content |
|---|
|
Discussion text to be put into box.
|
The padding parameter
The padding parameter adjusts the amount of cell padding (defaults to 8px):
{{Collapse|1=Discussion text to be put into box.|padding=20px}} creates the following (expand the box to see the border padding effect):
| Extended content |
|---|
|
Discussion text to be put into box.
|
The float parameter
The float parameter allows the collapsed content to float to the left, right, or center of the page (defaults to none with width = 100%):
{{Collapse|1=Discussion text to be put into box.|float=center}} creates the following:
| Extended content |
|---|
|
Discussion text to be put into box.
|
{{Collapse|1=Discussion text to be put into box.|float=center|width=30em}} creates the following:
| Extended content |
|---|
|
Discussion text to be put into box.
|
{{Collapse|1=Discussion text to be put into box.|float=left|width=30em}} creates the following:
| Extended content |
|---|
|
Discussion text to be put into box.
|
{{Collapse|1=Discussion text to be put into box.|float=right|width=30em}} creates the following:
| Extended content |
|---|
|
Discussion text to be put into box.
|
{{Collapse|1=Discussion text to be put into box.|float=none|width=30em}} creates the following:
| Extended content |
|---|
|
Discussion text to be put into box.
|
Around header text
When used with a section of text, include the section header in the collapsed portion of text. For example, given:
| == Heading == 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. |
Replace with:
{{subst:Collapse|1=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.|2=Heading}}
The expand parameter
Simply add |expand=yes to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: |expand= yes, y, expand, expanded, uncollapse, uncollapsed. Note: |expand=no will fold the box (default).
The clear parameter
In some situations you may not want the default 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.
When content includes tables
This template frequently breaks when used around content that consists of or includes wikitables. Such content can be made collapsible by using the {{collapse top}} and {{collapse bottom}} templates instead of {{collapse}}.
If you want to collapse only the table and not other content, you can do this using wikitable parameters. See the Collapsing tables guide for help.
TemplateData
TemplateData for Collapse
Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Contents | 1 | Contents of the box | Content | required |
| Title | 2 title heading header reason result | Text of title bar. Defaults to "Extended contents".
| String | suggested |
| Expanded by default? | expand | Setting to "yes, y, expand, uncollapse") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be collapsed by default (its contents hidden).
| String | optional |
| Border width | border | Width of the outermost border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px.
| String | optional |
| Title bar's color | bg background | Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.
| String | optional |
| Padding | padding | Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px.
| Unknown | optional |
| Outer background | bg1 | Color of the space between the inner and outer border. Can be set to any valid CSS color.
| String | optional |
| Outer border color | b-color | Color of the outer border. Can be any valid CSS color.
| String | optional |
| Collapse box width. | width | The width of the entire collapsed box.
| String | optional |
| Center-align title | center | If set to any value, the title will be centered. | String | optional |
| Font color | fc | Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color | String | optional |
Re-using at other wikis
This template depends upon having rules for the three classes (collapsible, uncollapsed, and collapsed) in the appropriate CSS files, and some related JavaScript installed. This template transcludes {{main other}} and {{lorem ipsum}}, which should also be imported at the same time.
For MediaWiki versions ≥ 1.18, this template can simply be exported and then imported into another MediaWiki installation. Changes to the source code that will need to be made are:
class="collapsibleneeds to be changed toclass="mw-collapsible(probably because the class had apparently been deprecated since MediaWiki v1.20).|#default=collapsed}}changed to|#default=mw-collapsed}}.- Some additional changes to the source code will need to be made in order for this template to become usable on the Main/Article (ns:0) namespace.
The toggle text can be edited at external Wiki's MediaWiki:Collapsible-expand and MediaWiki:Collapsible-collapse pages. Further information at jquery.makeCollapsible module.
See also
- {{collapse top}}
- {{collapse bottom}}
- {{discussion top}}
- {{archive top}}
- {{hidden archive top}}
