View source for Template:Collapse top/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page-->
{{Template shortcut|Cot|Cob}}

The {{tlx|collapse top}} template (or {{tlx|cot}}), and its paired template {{tlx|collapse bottom}} (or {{tlx|cob}}), are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables.

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

<pre>{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}</pre>
produces:
{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}

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

;positional parameter 1, named parameter 'title': These parameters give the main title of collapsed box, which occurs on the same line as the ''show'' link and is always visible. It defaults to 'Extended content'. For example, <code><nowiki>{{collapse top|This is the title text}}</nowiki></code> or <code><nowiki>{{collapse top|title=This is the title text}}</nowiki></code>
;positional parameter 2: This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter. For example, <code><nowiki>{{collapse top|This is the title text|This is a custom warning line}}</nowiki></code>
;left: If this parameter evaluates to true (i.e. is not empty) it will align the 'parameter 1 title' along the left margin. Text aligns centered between the left margin and the left bracket of the left ''show'' link by default. For example, <code><nowiki>{{collapse top|This is the title text|left=true}}</nowiki></code>
;expand: If this parameter evaluates to true (i.e. is not empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material. For example, <code><nowiki>{{collapse top|This is the title text|expand=true}}</nowiki></code>
;bg: Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from {{wplink|List of colors}}. For example, <code><nowiki>{{collapse top|This is the title text|bg=#F0F2F5}}</nowiki></code>
;fc: Sets the font color of the title of the collapsible bar. Defaults to Black. Other colors available from {{wplink|List of colors}}. For example, <code><nowiki>{{collapse top|This is the title text|fc=#F0F2F5}}</nowiki></code>
;border: Sets the width of the border line on the collapsed material. defaults to 1px. For example, <code><nowiki>{{collapse top|This is the title text|border=2px}}</nowiki></code>
;b-color: Sets the border color. defaults to silver. For example, <code><nowiki>{{collapse top|This is the title text|b-color=#F0F2F5}}</nowiki></code>
;padding: Sets the padding on the collapsed material in the colored area. Defaults to 8px. For example, <code><nowiki>{{collapse top|This is the title text|padding=16px}}</nowiki></code>
;width: Sets the width of the overall template. Use {{para|width|50%}}, not {{para|Width|50%}} as upper case "W" doesn't work. Or <code>|width=200px</code> (if you omit "px" it doesn't work).
;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). For example, <code><nowiki>{{collapse top|This is the title text|border2=2px}}</nowiki></code>
;bg2: Sets background of the box that appears when template is expanded; defaults to white. For example, <code><nowiki>{{collapse top|This is the title text|bg2=#F0F2F5}}</nowiki></code>
;indent: indents the box from the left of the page. Use: {{para|indent|50px}} not {{para|Indent|50px}} (upper case "I" doesn't work). Defaults to "do not indent" (i.e. 0px). Each ":" in wiki-markup is approximately equivalent to 25px indent.

If an entire section is being closed, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC. For example, <code><nowiki>{{collapse top|Section header}}</nowiki></code>

== Examples ==
* Adding a box title (if omitted, default is 'Extended content') - <code><nowiki>{{collapse top|This is the title text}}</nowiki></code>
{{collapse top|This is the title text}}
{{lorem ipsum}}
{{collapse bottom}}
* Adding a custom warning line - <code><nowiki>{{collapse top|This is the title text|This is a custom warning line}}</nowiki></code>
{{collapse top|This is the title text|This is a custom warning line}}
{{lorem ipsum}}
{{collapse bottom}}
* Aligning box title along left margin - <code><nowiki>{{collapse top|left=true}} or {{collapse top|left=true}}</nowiki></code>
{{collapse top|left=true}}
{{lorem ipsum}}
{{collapse bottom}}
* Changing background color - <code><nowiki>{{collapse top|bg=#F0F2F5}} or {{collapse top|bg=#F0F2F5}}</nowiki></code>
{{collapse top|bg=#F0F2F5}}
{{lorem ipsum}}
{{collapse bottom}}
* Adding extra padding - <code><nowiki>{{collapse top|padding=40px}}</nowiki></code>
{{collapse top|padding=40px}}
{{lorem ipsum}}
{{collapse bottom}}
* Archiving a section: the markup below:
<pre>{{collapse top}}
==Section header==
Sample contents text
{{collapse bottom}}</pre>
must be rewritten as: 
<pre>{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}</pre>
The end result:
{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}

== Redirects ==
To Collapse top:
* {{tl|cot}}
To Collapse bottom:
* {{tl|cob}}

== See also ==
* {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }}
* {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Collapse templates]]

}}</includeonly>