View source for Template:Collapse top/doc

{{Documentation subpage}}
<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
{{Redirect|Template:CTOP|Contentious-topics|Template:Contentious topics}}
{{Template shortcut|Cot|Cob}}
{{used in system|in [[MediaWiki:Protect-text]]}}

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. For very simple content, the one-piece template {{tlx|collapse}} can be used instead.
{{Warning|These templates don't work properly when you are using the [[WP:REPLYTOOL|Reply Tool]]. Specifically, any text after the collapsible box disappears. This is because the Reply Tool inserts indentation colons (<code>:</code>) to each line of your response, and {{tlx|collapse bottom}} needs to be placed on its own line, with no characters preceding it on that line. One simple workaround: post your reply anyway, then edit your post to remove the erring colon, and the template will start to work.}}
{{Template:Collapse Templates}}
This template '''should only be used by uninvolved editors''' in conjunction with the [[Wikipedia:talk page guidelines|talk page guidelines]] and relevant advice at [[WP:Refactoring]]. It should not be used by involved parties to end a discussion over the objections of other editors. See [[WP:SUPERHAT]].

Do not hide content in articles. This violates the {{Section link|Wikipedia:Manual of Style|Scrolling lists and collapsible content}} and [[Wikipedia:Accessibility]] guidelines.

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

<syntaxhighlight lang="wikitext">{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}</syntaxhighlight>
produces:
{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}


{{tlx|collapse bottom}} should always be placed on its own line. Do not place any characters before the template on this line. This means that if you use the [[WP:REPLYTOOL|Reply Tool]], you need to remember to manually remove the colon (<code>:</code>) or colons it inserts at the start of each line to maintain proper indentation after replying.

The entirety of {{tlx|collapse bottom}} that is transcluded  <code><nowiki>|}</div></nowiki></code> to easily keep track of which template concludes which collapsed block when editing a page's source.

== 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. <code>{{mxt|1em}}</code>, not <code>{{!mxt|1&nbsp;em}}</code>).

;{{para|1}}, {{para|title}}, {{para|reason}}, {{para|header}}, {{para|heading}}, {{para|result}}<span style="font-weight: normal;">, or first unnamed parameter</span>: 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, <code><nowiki>{{collapse top|title=This is the title text}}</nowiki></code> or <code><nowiki>{{collapse top|This is the title text}}</nowiki></code>. Note: The shorter, unnamed markup will not work if the title value contain an equals (<code>=</code>) character.
;{{para|warning|yes}}: Will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}" Any value supplied to this parameter will have this effect (i.e. {{para|warning|{{!mxt|no}}}} will not work as expected).
;{{para|2}}<span style="font-weight: normal;"> or second unnamed parameter</span>: This is optional warning-line text. It will override the standard warning line above; it is not necessary to also use {{para|warning|yes}} in this case, though doing so is harmless.
;{{para|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. {{para|left|{{!mxt|no}}}} will not work as expected); nor is there a {{para|{{!mxt|right}}}} parameter.
;{{para|expand|yes}} <span style="font-weight: normal;">or</span> {{para|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. {{para|expand|{{!mxt|no}}}} and {{para|collapse|{{!mxt|yes}}}} will not work as expected).
;{{para|bg}}: Sets the background color of the collapsed material. Defaults to <code>#CCFFCC</code>, a green hue. Named colors are listed at [[List of colors]]. For example, <code><nowiki>{{collapse top|This is the title text|bg=#F0F2F5}}</nowiki></code> or <code><nowiki>{{collapse top|This is the title text|bg=LightGrey}}</nowiki></code> (HTML hex color codes require the leading <code>#</code>).
;{{para|fc}}: Sets the font color of the title of the collapsible bar. Defaults to inheriting the current text color of the context. See {{para|bg}}, above, for details on color options.
;{{para|border}}: Sets the width of the border line on the collapsed material. defaults to <code>1px</code>. For example, <code><nowiki>{{collapse top|border=2px}}</nowiki></code>; going much thicker than this is not very useful.
;{{para|b-color}}: Sets the border color. defaults to <code>Silver</code> (<code>#C0C0C0</code>). See {{para|bg}}, above, for details on color options.
;{{para|padding}}: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>0.6em</code>.
;{{para|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. {{para|width|50%}}, or in relative <samp>em</samp> units, e.g. {{para|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.).
;{{para|border2}}: Sets the properties of the border of the box that appears when template is expanded; defaults to <code>1px Silver</code> (there is no provision to change from a solid line). For example, <code><nowiki>{{collapse top|border2=2px}}</nowiki></code> (only width or color will be changed if only one value is supplied).   See {{para|bg}}, above, for details on color options.
;{{para|bg2}}: Sets the background color of the box that appears when template is expanded; defaults to <code>White</code> (<code>#FFFFFF</code>). See {{para|bg}}, above, for details on color options.
;{{para|indent}}: Indents the box from the left of the page. Defaults to no indentation. Each <code>:</code> in talk page markup is approximately equivalent to <code>1.6em</code> of indent (e.g., to match <code>::::</code> indentation level, use {{para|indent|6.4em}}). You can also use a percentage value. Pixel-based values should be avoided (see {{para|width}}, above, for why).
;{{para|clear}}: In some situations you may not want the default <code>clear: both;</code> 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 {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed.

== 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 standard warning line – <code><nowiki>{{collapse top|This is the title text|warning=true}}</nowiki></code>
{{collapse top|This is the title text|warning=true}}
{{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}}</nowiki><!-- or {{collapse top|left=true}}--><nowiki></nowiki></code>
{{collapse top|left=true}}
{{lorem ipsum}}
{{collapse bottom}}
* Changing background color – <code><nowiki>{{collapse top|bg=#F0F2F5}}</nowiki></code>
{{collapse top|bg=#F0F2F5}}
{{lorem ipsum}}
{{collapse bottom}}
* Adding extra padding – <code><nowiki>{{collapse top|padding=5em}}</nowiki></code>
{{collapse top|padding=5em}}
{{lorem ipsum}}
{{collapse bottom}}
* Archiving a section: the markup below:
<syntaxhighlight lang="wikitext">{{collapse top}}
==Section header==
Sample contents text
{{collapse bottom}}</syntaxhighlight>
must be rewritten as:
<syntaxhighlight lang="wikitext">{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}</syntaxhighlight>
The end result:
{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}

==Limitations==
{{transcluded section|source=Help:Collapsing#Limitations}}
{{#section-h:Help:Collapsing|Limitations}}

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"1": {
			"aliases": [
				"title",
				"heading",
				"header",
				"reason",
				"result"
			],
			"label": "Title",
			"description": "Main title of collapsed box",
			"example": "This is the title text",
			"type": "line",
			"default": "Extended content"
		},
		"2": {
			"label": "Custom warning line",
			"description": "Will override the standard warning line, and make the 'warning' parameter unnecessary",
			"example": "This is a custom warning line",
			"type": "string",
			"default": "The following is a closed discussion. {{strongbad|Please do not modify it.}}"
		},
		"indent": {
			"label": "Indent (px or em)",
			"description": "Indents the box from the left of the page",
			"type": "unknown",
			"autovalue": "0px"
		},
		"expand": {
			"aliases": [
				"collapse"
			],
			"description": "Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring",
			"example": "true",
			"type": "string",
			"autovalue": ""
		},
		"border": {
			"label": "Border width (px)",
			"description": "Sets the width of the border line on the collapsed material",
			"example": "2px",
			"default": "1px",
			"autovalue": ""
		},
		"b-color": {
			"label": "Border color",
			"description": "Sets the border color",
			"example": "#F0F2F5",
			"default": "Silver"
		},
		"width": {
			"label": "Template width (% or em)",
			"description": "Sets the width of the overall template",
			"example": "50%"
		},
		"bg": {
			"label": "Collapsed material background color",
			"description": "Sets the background color of the collapsed material",
			"example": "#F0F2F5",
			"default": "#CFC"
		},
		"left": {
			"label": "Alight along the left margin (true or blank)",
			"description": "Will align the 'parameter 1 title' along the left margin",
			"example": "true",
			"type": "string"
		},
		"fc": {
			"label": "Title font color",
			"description": "Sets the font color of the title of the collapsible bar",
			"example": "#F0F2F5",
			"default": "Black"
		},
		"warning": {
			"label": "Warning (true or blank)",
			"description": "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"
		},
		"border2": {
			"label": "Expanded box border size & color",
			"description": "Sets the border of the box that appears when template is expanded",
			"example": "2px",
			"default": "1px silver"
		},
		"padding": {
			"label": "Padding (px)",
			"description": "Sets the padding on the collapsed material in the colored area",
			"example": "16px",
			"default": "8px"
		},
		"bg2": {
			"label": "Expanded box color",
			"description": "Sets background of the box that appears when template is expanded",
			"example": "#F0F2F5",
			"default": "white"
		}
	},
	"description": "Use in conjunction with {{Collapse bottom}}. Will collapse text in between the two templates."
}
</templatedata>

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

== See also ==
* {{tl|collapse}}
* {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }}
* {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }}
* {{tl|discussion top}} and {{tl|discussion bottom}}
* {{tl|hidden archive top}} and {{tl|hidden archive bottom}}
* {{tl|hidden begin}} and {{tl|hidden end}}
* {{tl|hidden}}
* {{tl|collapsible list}}

{{Warchivenav|state=uncollapsed}}

<includeonly>{{Sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Wikipedia archived wrapper templates]]
[[Category:Collapse templates]]
}}</includeonly>