Template:Collapse top/doc

The collapse template is used for placing collapse boxes around discussions.

Usage

{{Collapse top}}

Place {{collapse top}} and {{collapse bottom}} around the text to be collapsed. If an entire section is being archived, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC.

Template parameters

Parameter Description Default Status
1
title
reason
header
heading
header These parameters give the main title of collapsed box, which occurs on the same line as the show link and is always visible. Extended content optional
warning
show warning text If this parameter evaluates to true (i.e. is not 0, false, or empty) it will display a default warning line under the main title which reads 'The following is an archived debate. Please do not modify it.' (except if parameter #2 is given). empty optional
2
custom warning text This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter. empty optional
expand
expand If this parameter evaluates to true (i.e. is not 0, false, or empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material. empty optional
bg
background Sets the background color of the collapsed material #CFC - a pleasant green optional
border
border width Sets the width of the border line on the collapsed material. 1px optional
b-color
border color Sets the border color. silver optional
padding
padding Sets the padding on the collapsed material in the colored area. 8px optional
width
box width Sets the width of the overall template empty optional

Additional information

The template is intended to be used in the following namespaces: all talk namespaces

The template is intended to be used by the following user groups: no user group specified

See also

Localization

This template is not intended to be localized.

Examples

Simple

{{Collapse top|This is the title text}}
{{lorem ipsum}}
{{Collapse bottom}}

Changing background color

{{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}

Changing border color

{{cot|b-color=#ff0000}}

Adding extra padding

{{cot|padding=40px}}

Adding a warning line

{{cot|default warning|warning=1}}
{{cot|custom warning|this is a custom warning line}}

Archiving a section

{{cot}}
==section header==
text
{{cob}}

rewritten as

{{cot|section header}}
text
{{cob}}
Last modified on 18 February 2014, at 20:28