Template:Collapse bottom

Template documentation[view] [edit] [history] [purge]

"Template:CTOP" redirects here. For Contentious-topics, see Template:Contentious topics.

The {{collapse top}} template (or {{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.

This template should only be used by uninvolved editors in conjunction with the talk page guidelines and relevant advice at WP:Refactoring. It should not be used by involved parties to end a discussion over the objections of other editors. See WP:SUPERHAT.

Do not hide content in articles. This violates the Wikipedia:Manual of Style § Scrolling lists and collapsible content and Wikipedia:Accessibility guidelines.

Usage

Place {{collapse top}} (or {{cot}}), and {{collapse bottom}} (or {{cob}}), around the text to be collapsed. For example:

<syntaxhighlight lang="wikitext">

This is the title text
Sample contents text

</syntaxhighlight>

produces:

This is the title text
Sample contents text

{{collapse bottom}} should always be placed on its own line. Do not place any characters before the template on this line. This means that if you use the Reply Tool, you need to remember to manually remove the colon (:) or colons it inserts at the start of each line to maintain proper indentation after replying.

The entirety of {{collapse bottom}} that is transcluded |}</div> to easily keep track of which template concludes which collapsed block when editing a page's source.

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=, |result=, 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. Please do not modify it." Any value supplied to this parameter will have this effect (i.e. |warning=no 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. 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=no will not work as expected); nor is there a |right= parameter.

|expand=yes or |collapse=no

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=no and |collapse=yes will not work as expected).

|bg=

Sets the background color of the collapsed material. Defaults to #CCFFCC, a green hue. Named colors are listed at List of colors. For example, {{collapse top|This is the title text|bg=#F0F2F5}} or {{collapse top|This is the title text|bg=LightGrey}} (HTML hex color codes require the leading #).

|fc=

Sets the font color of the title of the collapsible bar. Defaults to inheriting the current text color of the context. 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 0.6em.

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

|clear=

In some situations you may not want the default clear: both; CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use |clear=none, |clear=right, or |clear=left, as needed.

Examples

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

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.

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

This is the title text
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.

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

This is the title text
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.

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

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.

• Changing background color – {{collapse top|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 – {{collapse top|padding=5em}}

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.

• Archiving a section: the markup below:

<syntaxhighlight lang="wikitext">

Extended content
Section header Sample contents text

</syntaxhighlight>

must be rewritten as: <syntaxhighlight lang="wikitext">

Section header
Sample contents text

</syntaxhighlight>

The end result:

Section header
Sample contents text

Limitations

{{#section-h:Help:Collapsing|Limitations}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Collapse bottom in articles based on its TemplateData.

TemplateData for Collapse bottom

<templatedata> { "params": { "1": { "aliases": [ "title", "heading", "header", "reason", "result" ], "label": "Title", "description": "Main title of collapsed box", "example": "This is the title text", "type": "line", "default": "Extended content" }, "2": { "label": "Custom warning line", "description": "Will override the standard warning line, and make the 'warning' parameter unnecessary", "example": "This is a custom warning line", "type": "string", "default": "The following is a closed discussion. Please do not modify it." }, "indent": { "label": "Indent (px or em)", "description": "Indents the box from the left of the page", "type": "unknown", "autovalue": "0px" }, "expand": { "aliases": [ "collapse" ], "description": "Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring", "example": "true", "type": "string", "autovalue": "" }, "border": { "label": "Border width (px)", "description": "Sets the width of the border line on the collapsed material", "example": "2px", "default": "1px", "autovalue": "" }, "b-color": { "label": "Border color", "description": "Sets the border color", "example": "#F0F2F5", "default": "Silver" }, "width": { "label": "Template width (% or em)", "description": "Sets the width of the overall template", "example": "50%" }, "bg": { "label": "Collapsed material background color", "description": "Sets the background color of the collapsed material", "example": "#F0F2F5", "default": "#CFC" }, "left": { "label": "Alight along the left margin (true or blank)", "description": "Will align the 'parameter 1 title' along the left margin", "example": "true", "type": "string" }, "fc": { "label": "Title font color", "description": "Sets the font color of the title of the collapsible bar", "example": "#F0F2F5", "default": "Black" }, "warning": { "label": "Warning (true or blank)", "description": "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" }, "border2": { "label": "Expanded box border size & color", "description": "Sets the border of the box that appears when template is expanded", "example": "2px", "default": "1px silver" }, "padding": { "label": "Padding (px)", "description": "Sets the padding on the collapsed material in the colored area", "example": "16px", "default": "8px" }, "bg2": { "label": "Expanded box color", "description": "Sets background of the box that appears when template is expanded", "example": "#F0F2F5", "default": "white" } },

"description": "Use in conjunction with |}

. Will collapse text in between the two templates."

} </templatedata>

Redirects

To Collapse top:

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

To Collapse bottom:

• {{cob}}
• {{cbot}}

See also

• {{collapse}}
• {{collapse top}}
• {{discussion top}} and {{discussion bottom}}
• {{hidden archive top}} and {{hidden archive bottom}}
• {{hidden begin}} and {{hidden end}}
• {{hidden}}
• {{collapsible list}}

The above documentation is transcluded from Template:Collapse top/doc. (edit | history)
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Subpages of this template.