Template:Collapse top/doc: Difference between revisions

The {{tlx|collapse top}} template (a.k.a. {{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. For very simple content, the one-piece template {{tlx|collapse}} can be used instead.  

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

<pre>{{Collapse top|title=This is the title text}}

{{Collapse bottom}}</pre>

{{Collapse top|title=This is the title text}}

{{Collapse bottom}}

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

;warning: If this parameter evaluates to true (i.e. is not empty) it will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}"

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

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

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

;bg: Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from [[List of colors]].

;fc: Sets the font color of the title of the collapsible bar. Defaults to Black. Other colors available from [[List of colors]].

;border: Sets the width of the border line on 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 {{para|width|50%}}, not {{para|Width|50%}} (Upper case "W" doesn't work) or <code>|width=200</code> (omits "px" and doesn't work).

;border2: Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line)

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

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

*aligning title along left margin - <nowiki>{{Collapse top|left=true}} or {{cot|left=right}}</nowiki>

{{cot|left=right}}

*changing background color - <nowiki>{{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}</nowiki>

{{cot|bg=#F0F2F5}}

*adding extra padding - <nowiki>{{cot|padding=40px}}</nowiki>

{{cot|padding=40px}}

*adding a warning line - <nowiki>{{cot|default warning|warning=1}}</nowiki>, <nowiki>{{cot|custom warning|this is a custom warning line}}</nowiki>

{{cot|default warning|warning=1}}

{{cot|custom warning|this is a custom warning line}}

*archiving a section

==section header==

text

rewritten as  

<pre>{{cot|section header}}

text

{{cot|section header}}

text