Template:Collapse top

Extended content
The following content has been placed in a collapsed box for improved usability.

Template documentation

The {{Collapse top}} template, and its paired template {{Collapse bottom}}, are used for placing a collapse box around a talk page discussion.

Usage

Place {{Collapse top}} and {{Collapse bottom}} 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.

Parameters

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= (or first unnamed parameter), |title=, |reason=, |header=, |heading=: Will give the collapsed box a title, which occurs on the same line as the show link and is always visible. It defaults to "Extended content".; For example, {{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: Will display a default warning line under the main title which reads "The following is a closed debate. Please do not modify it."; Any non-empty value supplied to this parameter will have this effect (i.e. |warning= will not work as expected).
|2= (or second unnamed parameter): This is optional warning-line text. It will override the standard warning line above; it is not necessary to also use |warning=yes in this case, though doing so is harmless.
|left=yes: Will align the title along the left margin (in RTL languages, along the right margin instead).; By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.; Any non-empty value supplied to this parameter will have this effect (i.e. |left= will not work as expected).
|expand=yes: Will leave the material uncollapsed with the border and coloring. Default is to collapse the material.; Any non-empty value supplied to this parameter will have this effect (i.e. |expand= will not work as expected).
|bg=: Sets the background color of the title of the collapsible bar. Defaults to "#F8FCFF", a whitish color. Named colors are listed at List of colors.; For example, {{Collapse top|This is the title text|bg=#008000}} or {{Collapse top|This is the title text|bg=green}} (numeric HTML color codes require the leading #).
|fc=: Sets the font color of the title of the collapsible bar. Defaults to "black".; See |bg=, above, for details on color options.
|border=: Sets the width of the border line on the collapsed material. Defaults to 1px.; For example, {{Collapse top|border=2px}}; going much thicker than this is not very useful.
|b-color=: Sets the border color. Defaults to silver (#C0C0C0).; See |bg=, above, for details on color options.
|padding=: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to 8px.
|width=: Sets the width of the overall template relative to the page (or a block element containing the collapse box). This should virtually always be given as a percentage, e.g. |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=: Sets the properties of the border of the box that appears when template is expanded. Defaults to 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=: Sets the background color of the box that appears when template is expanded; defaults to white (#FFF).; See |bg=, above, for details on color options.
|indent=: Indents the box from the left of the page. Defaults to no indentation. Each : 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 the reason).

Examples

Adding a box title (if omitted, default is "Extended content") – {{Collapse top|This is the title text}}

This is the title text

Adding a standard warning line – {{Collapse top|This is the title text|warning=true}}

This is the title text

Adding a custom warning line – {{Collapse top|This is the title text|This is a custom warning line}}

This is the title text

Aligning box title along left margin – {{Collapse top|left=true}}

Extended content

Changing background color – {{Collapse top|bg=#F0F2F5}}

Extended content

Adding extra padding – {{Collapse top|padding=5em}}

Extended content

Archiving a section – The markup below:

{{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

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Collapse top

Use in conjunction with {{Collapse bottom}}. Will collapse text in between the two templates.

Template parameters[Edit template data]
Parameter		Description	Type	Status
Title	`1` `title` `heading` `header` `reason` `result`	Main title of collapsed box Example This is the title text	Unknown	required
Custom warning line	`2`	Will override the standard warning line, and make the 'warning' parameter unnecessary Example This is a custom warning line	String	optional
indent	`indent`	Indents the box from the left of the page Auto value `0px`	Unknown	optional
expand	`expand` `collapse`	Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring Example true Auto value	String	optional
Border width (px)	`border`	Sets the width of the border line on the collapsed material Default 1px Example 2px Auto value	Unknown	optional
Border color	`b-color`	Sets the border color Default Silver Example #F0F2F5	Unknown	optional
Template width (px or %)	`width`	Sets the width of the overall template Example 50%	Unknown	optional
Collapsed material background color	`bg`	Sets the background color of the collapsed material Default #CFC Example #F0F2F5	Unknown	optional
Alight along the left margin (true or blank)	`left`	Will align the 'parameter 1 title' along the left margin Default Example true	String	optional
Title font color	`fc`	Sets the font color of the title of the collapsible bar Default Black Example #F0F2F5	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." Example true	Unknown	optional
Expanded box border size & color	`border2`	Sets the border of the box that appears when template is expanded Default 1px silver Example 2px	Unknown	optional
Padding (px)	`padding`	Sets the padding on the collapsed material in the colored area Default 8px Example 16px	Unknown	optional
Expanded box color	`bg2`	Sets background of the box that appears when template is expanded Default white Example #F0F2F5	Unknown	optional

Usage

Parameters

Examples

TemplateData

See also