Template:Collapse top/doc

The template (or ), and its paired template  (or ), 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 can be used instead.

These templates should only be used in accordance with the Refactoring guideline; they should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Do not hide content in articles. This violates the and Accessibility guidelines.

Usage
Place (or ), and  (or ), around the text to be collapsed. For example:

Sample contents text produces:

Sample contents text

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)

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


 * 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,  or  . Note: The shorter, unnamed markup will not work if the title value contain an equals  character.
 * 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. 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 yes in this case, though doing so is harmless.
 * 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. no will not work as expected); nor is there a right parameter.
 * yes or 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. no and yes will not work as expected).
 * bg: Sets the background color of the collapsed material. Defaults to, a green hue. Named colors are listed at List of colors. For example,   or   (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 . For example,  ; going much thicker than this is not very useful.
 * b-color: Sets the border color. defaults to  . 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.
 * 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. 50%, or in relative em units, e.g. 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  (there is no provision to change from a solid line). For example,   (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  . 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   of indent (e.g., to match   indentation level, use 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  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 none, right, or left, as needed.

Examples

 * Adding a box title (if omitted, default is 'Extended content') –


 * Adding a standard warning line –


 * Adding a custom warning line –


 * Aligning box title along left margin –


 * Changing background color –


 * Adding extra padding –


 * Archiving a section: the markup below:

Section header
Sample contents text must be rewritten as: Sample contents text The end result:

Sample contents text

TemplateData
{	"params": { "1": {			"aliases": [ "title", "heading", "header", "reason", "result" ],			"label": "Title", "description": "Main title of collapsed box", "example": "This is the title text", "required": true },		"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" },		"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." }

Redirects
To Collapse top: To Collapse bottom:
 * cot
 * ctop
 * DAT
 * cob
 * cbot