Template:Collapse top/doc

The Collapse template is used for placing collapse boxes around discussions. It is a two-part template, used in conjunction with {{Collapse bottom}} ({{Cob}}).

This template should only be used in accordance with the refactoring guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Usage

Place {{Collapse top}} and {{Collapse bottom}} arounf the text to be collapsed. example:

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

produces

This is the title text

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Parameters

This template takes the following parameters, all of which are optional

positional parameter 1, named parameter 'title'

These parameters give the main title of collapsed box, which occurs on the same line as the show link and is always visible. It defaults to 'Extended content'.

warning

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

positional parameter 2

This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.

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

'bg'

Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green.

'border'

Sets the width of the border line on the collapsed material. defaults to 1px.

'padding'

Sets the padding on the collapsed material in the colored area. defaults to 8 px

'width'

Sets the width of the overall template

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.

Examples

• changing background color - {{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}

Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

• adding extra padding - {{cot|padding=40px}}

Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

• adding a warning line - {{cot|default warning|warning=1}}, {{cot|custom warning|this is a custom warning line}}

default warning
The following is a closed debate. Please do not modify it.
Lorem ipsum dolor sit amet, consectetur adipisicing 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.

custom warning
this is a custom warning line
Lorem ipsum dolor sit amet, consectetur adipisicing 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.

• archiving a section

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

rewritten as

{{cot|section header}}
text
{{cob}}

section header
text

See also

• {{Collapse bottom}}