Template:Collapse/doc
Don't forget to purge the contents of the base page upon creating or editing this subpage.
This template's documentation was also ported from Wikipedia, originally from Template:Collapse/doc/doc. The original authors of the documentation are shown on the documentation's edit history page.
Wikipedia's text is available under the Creative Commons Attribution-ShareAlike 3.0 Unported License.
The {{collapse|folding text}} template is used for placing collapse boxes around short text and bits of text. To fold long bits of text, use {{Collapse top}}... lots of text ...{{Collapse bottom}}.
Usage
{{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.
See also
{{collapse top}}{{collapse bottom}}