Template:Collapse top/doc

Description
Template:Collapse top (shortcut → ) and its paired template, Template:Collapse bottom (shortcut → ), 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.

Syntax
Place and  around the text to be collapsed.


 * Example


 * produces:

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


 * 1 : title gives the main title to the 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. "


 * 2 : This is an 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</tt>), 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 at Web colors.


 * border : Sets the width of the border line of 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 700px, not 700px: Upper case "W" does not work. Additionally, do not omit "px", which also does not work; that is, use 700px and not 700. width can also be expressed as a percent (e.g., 100%)


 * border2 : Sets 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.


 * bg2 : Sets background of the box that appears when template is expanded. Defaults to white.

If an entire section is being archived, remove the section header, and add it as the first parameter (i.e., 1) of the template. This keeps the section header from showing in the table of contents.

Example #1: Background color

 * changing background color:

or


 * produces …

Example #2: Padding

 * adding extra padding


 * produces …

Example #3: Warning (default)

 * adding a warning line


 * produces …

Example #4: Warning (custom)

 * produces …

Example #5: Archiving

 * archiving a section

section header
text


 * rewritten as …

text


 * produces …

text