Template:Collapse top/en

<languages />

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:

{{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=, |title=, |reason=, |header=, |heading= , or first unnamed parameter

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. Template:Strong" Any 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 value will enable this parameter (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 value 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}} (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 (#FFFFFF). 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 why).

Examples

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

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

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

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

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

• Adding extra padding – {{collapse top|padding=5em}}

• 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:

TemplateData

See also

• {{collapse bottom}}
• {{hidden archive top}} and {{hidden archive bottom}}
• {{hidden begin}} and {{hidden end}}
• {{hidden}}}

[[Category:Formatting templates{{#translation:}}]]

Editors can experiment in this template’s sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.