Template:Collapse top/doc

The {{collapse top}} template (a.k.a. {{cot}}) and its paired template {{collapse bottom}} (or {{cob}}) are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables. For very simple content, the one-piece template {{collapse}} can be used instead.

These templates should only be used in accordance with the Wikipedia:Refactoring guideline; they 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}} around the text to be collapsed. For example:

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

produces:

This is the title text

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.

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 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 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. Other colors available from List of colors.

'border'

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

'b-color'

Sets the border color. defaults to silver.

'padding'

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

'width'

Sets the width of the overall template. Use |width=50%, not |Width=50% (Upper case "W" doesn't work) or |width=200 (omits "px" and doesn't work).

'border2'

Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line)

'bg2'

Sets background of the box that appears when template is expanded; defaults to white.

'indent'

indents the box from the left of the page. Use: |indent=50px not |Indent=50px (Upper case "I" doesn't work). Defaults to "do not indent" (ie, 0px). Each ":" in wiki-markup is approximately equivalent to 25px indent.

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

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

Extended content

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.

• 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 discussion. Please do not modify it.
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.

custom warning
this is a custom warning line
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.

• archiving a section

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

rewritten as

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

section header
text

Redirects

To Collapse top:

• {{cot}}
• {{DAT}}

To Collapse bottom:

• {{cob}}
• {{hab}}
• {{hidden archive bottom}}

See also

• {{collapse}}
• {{collapse bottom}}
• {{discussion top}}
• {{hidden archive top}}