Template:Collapse top/doc

Usage

Place {{collapse top}} and {{collapse bottom}} around the text to be collapsed. For example:

{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}

produces:

This is the title text
Sample contents text

{{collapse bottom}} should always be placed on its own line.

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). |title= 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 "Collapsible box title".

|left=yes will align the title along the left margin. By default, the title text is centered.

|expand=yes will leave the material uncollapsed with the border and coloring. Default is to collapse the material.

|bg= sets the background color of the title box. Defaults to #EDEEEF. Named colors are listed at wikipedia:List of colors

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

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

|bg2= sets the background color of the box that appears when template is expanded. Defaults to #F8F9FA. See |bg=, above, for details on color options.

|indent= indents the box from the left of the page. Defaults to no indentation.

|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
Sample text here

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

Collapsible box title
Sample text here

• Changing background color – {{collapse top|bg=#CCFFCC}}

Collapsible box title
Sample text here

• Adding extra padding – {{collapse top|padding=5em}}

Collapsible box title
Sample text here

• Archiving a section: the markup below:

{{collapse top}}
==Section header==
Sample contents text
{{collapse bottom}}

must be rewritten as:

{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}

The end result:

Section header
Sample contents text