Template:Collapse/doc

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}}. There are cases where these template will not work. See Help:Collapsing for other options.

This template 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.

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=.

This works with collapsed bulleted list (the first bullet will look correct):
{{Collapse|title=|Bulleted list}} Start bulleted list on a new line.

HTML version

If you find that the template does not function properly in a particular circumstance, this is most likely because the wikicode table markup ({|, etc.) only works when it is at the beginning of a newline.

A workaround for this is the "pure HTML" (<table>, etc.) variant of this template, {{Collapse/HTML}}, which is identical (same parameters, etc.) other than in not using wikimarkup for the layout-table code.

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.

Limitations

{{#section-h:Help:Collapsing|Limitations}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Collapse in articles based on its TemplateData.

TemplateData for Collapse

<templatedata> { "description": "Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.", "params": { "1": { "label": "Contents", "description": "Contents of the box", "type": "content", "required": true, "aliases": [ "content", "text" ] }, "2": { "label": "Title", "description": "Text of title bar. Defaults to \"Extended contents\".", "type": "string", "suggested": true, "aliases": [ "title", "heading", "header", "reason", "result" ], "default": "Extended content" }, "expand": { "label": "Expanded by default?", "description": "Setting to \"yes\" (or \"y\", \"expand\", \"expanded\", \"uncollapse\", or \"uncollapsed\") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be expanded by default. If not set or set to another value (e.g. \"no\") the box will be collapsed by default (its contents hidden).", "type": "string", "default": "no" }, "border": { "label": "Border width", "description": "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.", "type": "string", "default": "1px" }, "bg": { "label": "Title bar's color", "description": "Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.", "type": "string", "aliases": [ "background" ], "default": "#F0F2F5" }, "padding": { "label": "Padding", "description": "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.", "default": "8px" }, "bg1": { "label": "Outer background", "description": "Color of the space between the inner and outer border. Can be set to any valid CSS color.", "type": "string", "default": "transparent" }, "b-color": { "label": "Outer border color", "description": "Color of the outer border. Can be any valid CSS color.", "type": "string", "default": "silver" }, "width": { "label": "Collapse box width", "description": "The width of the entire collapsed box.", "type": "string", "default": "100%" }, "center": { "label": "Center-align title", "description": "If set to any value, the title will be centered.", "type": "boolean" }, "fc": { "label": "Font color", "description": "Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color", "type": "string" }, "class": { "label": "CSS class", "description": "Additional CSS class to add", "type": "string" }, "float": { "label": "CSS float", "description": "CSS float, one of \"left\", \"right\", \"none\", \"center\"/\"centre\", or blank.", "type": "string" }, "clear": { "label": "CSS clear", "description": "CSS clear value. The default depends on the selected float. Usually one of \"none\", \"left\", \"right\", or \"both\"", "type": "string" }, "left": { "label": "Left-align title", "description": "Left-aligns the title. Takes precedence over center.", "type": "boolean" }, "border2": { "label": "Content border", "description": "CSS border styling to add to the content.", "type": "string", "default": "1px silver" }, "bg2": { "label": "Content background color", "description": "Background color to use for expanded content.", "type": "string", "default": "white" } } } </templatedata>

Re-using at other wikis

This template depends upon using the three classes mw-collapsible, mw-uncollapsed and mw-collapsed, which are part of MediaWiki versions ≥ 1.18. For wikis using these version of MediaWiki, this template can simply be exported and then imported into another MediaWiki installation. This template transcludes {{main other}} and {{lorem ipsum}}, which should also be imported at the same time. Some 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}} and {{Collapse bottom}}
• {{discussion top}}
• {{hidden}}