Template:Collapse top/doc View history

Revision as of 16:18, 12 August 2022 by Kentsmith9 (talk | contribs) (Initial doc creation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
This is a documentation subpage for Template:Collapse top.
It contains usage information, categories and other content that is not part of the original template page.

The {{collapse top}} template, and its paired template {{collapse bottom}}, 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}}
Sample contents text
{{collapse bottom}}

produces:


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

|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 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}}
  • Adding a standard warning line – {{collapse top|This is the title text|warning=true}}
  • Adding a custom warning line – {{collapse top|This is the title text|This is a custom warning line}}
  • Aligning box title along left margin – {{collapse top|left=true}}
  • Changing background color – {{collapse top|bg=#F0F2F5}}
  • Adding extra padding – {{collapse top|padding=5em}}
  • 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:


TemplateData

Template:TemplateData header

Use in conjunction with {{Collapse bottom}}. Will collapse text in between the two templates.

Template parameters

ParameterDescriptionTypeStatus
Title1 title heading header reason result

Main title of collapsed box

Example
This is the title text
Unknownrequired
Custom warning line2

Will override the standard warning line, and make the 'warning' parameter unnecessary

Example
This is a custom warning line
Stringoptional
indentindent

Indents the box from the left of the page

Auto value
0px
Unknownoptional
expandexpand collapse

Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring

Example
true
Auto value
Stringoptional
Border width (px)border

Sets the width of the border line on the collapsed material

Default
1px
Example
2px
Auto value
Unknownoptional
Border colorb-color

Sets the border color

Default
Silver
Example
#F0F2F5
Unknownoptional
Template width (px or %)width

Sets the width of the overall template

Example
50%
Unknownoptional
Collapsed material background colorbg

Sets the background color of the collapsed material

Default
#CFC
Example
#F0F2F5
Unknownoptional
Alight along the left margin (true or blank)left

Will align the 'parameter 1 title' along the left margin

Example
true
Stringoptional
Title font colorfc

Sets the font color of the title of the collapsible bar

Default
Black
Example
#F0F2F5
Unknownoptional
Warning (true or blank)warning

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
Unknownoptional
Expanded box border size & colorborder2

Sets the border of the box that appears when template is expanded

Default
1px silver
Example
2px
Unknownoptional
Padding (px)padding

Sets the padding on the collapsed material in the colored area

Default
8px
Example
16px
Unknownoptional
Expanded box colorbg2

Sets background of the box that appears when template is expanded

Default
white
Example
#F0F2F5
Unknownoptional