View source for Template:Collapse/doc

{{Documentation subpage}}


{{Template:Collapsible templates}}

The {{tlx|collapse|<nowiki>folding text</nowiki>}} template is used for placing collapse boxes around ''short'' discussions and bits of discussions. To fold ''long'' discussion threads, use {{tlx|Collapse top}}<code>... lots of text ...</code>{{tlx|Collapse bottom}}.

This template should only be used in accordance with the refactoring talk pages guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Do not hide content in articles. This violates the wiki guidelines.

== Usage ==

'''''Note: {{Tl|Collapse}} needs to be substed in order for the time stamp functionality to work properly.'''''

{{Tlx|Collapse|1&#61;<var>Discussion text to be put into box.</var>|2&#61;<var>Optional custom heading</var>}}

It is definitely safest to use the named {{para|1}} and {{para|2}} parameters, because otherwise any "=" character will break the template.

For compatibility with various discussion-boxing and -closing, and discussion-wrapping templates, {{para|1}} can also be given as {{para|content}} or {{para|text}}, and {{para|2}} can also be given as {{para|title}}, {{para|reason}}, {{para|header}}, {{para|heading}}, or {{para|result}}.

=== The <code>bg</code> parameter ===

The <code>bg</code> parameter is optional. It changes the background color. Use [[Web color]] values (e.g. <code>#F0F2F5</code>).

;Example:
 
<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|bg=#F0F2F5}<nowiki />}</code> creates:

{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}}

=== The <code>padding</code> parameter ===
The <code>padding</code> parameter adjusts the amount of cell padding (defaults to <code>8px</code>):

<code>{<nowiki />{Collapse|1=<var>Discussion text to be put into box.</var>|padding=20px}<nowiki />}</code> creates the following (expand the box to see the border padding effect):

{{Collapse|1=Discussion text to be put into box.|padding=20px}}

=== The <code>float</code> parameter ===
The <code>float</code> parameter allows the collapsed content to float to the left, right, or center of the page (defaults to <code>none</code> with <code>width = 100%</code>):

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=center}}

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=center|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=center|width=30em}}

<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=left|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=left|width=30em}}
{{clear}}
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=right|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=right|width=30em}}
{{clear}}
<code><nowiki>{{</nowiki>Collapse|1=<var>Discussion text to be put into box.</var>|float=none|width=30em<nowiki>}}</nowiki></code> creates the following:

{{Collapse|1=Discussion text to be put into box.|float=none|width=30em}}

=== Around header text ===

When used with a section of text, include the section header in the collapsed portion of text. For example, given:

{| style="background-color: lavender"
| Example text|&#x3d;&#x3d; [[Help:Section|Heading]] &#x3d;&#x3d;<br />{{Lorem ipsum}}
|}

Replace with:

<code>{{Tlsp|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[Help:Section|Heading]]}}</code>

===The <code>expand</code> parameter===
Simply add {{para|expand|yes}} to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: {{para|expand|}} <code>yes, y, expand, expanded, uncollapse, uncollapsed</code>. Note: {{para|expand|no}} will fold the box (default).

===The <code>clear</code> parameter===
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.

===When content includes tables===
This template frequently breaks when used around content that consists of or includes [[Help:Table|wikitables]]. Such content can be made collapsible by using the {{tlx|collapse top}} and {{tlx|collapse bottom}} templates instead of {{tlx|collapse}}. 

If you want to collapse only the table and not other content, you can do this using wikitable parameters. See the [[Help:Collapsing#Collapsing tables by default|Collapsing tables]] guide for help.

==TemplateData==
{{TemplateData header}}
<templatedata>
{
	"description": "Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.",
	"params": {
		"1": {
			"label": "Contents",
			"description": "Contents of the box",
			"type": "content",
			"required": true,
			"aliases": [
				"content",
				"text"
			]
		},
		"2": {
			"label": "Title",
			"description": "Text of title bar. Defaults to \"Extended contents\".",
			"type": "string",
			"suggested": true,
			"aliases": [
				"title",
				"heading",
				"header",
				"reason",
				"result"
			],
			"default": "Extended content"
		},
		"expand": {
			"label": "Expanded by default?",
			"description": "Setting to \"yes\" (or \"y\", \"expand\", \"expanded\", \"uncollapse\", or \"uncollapsed\") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be expanded by default.  If not set or set to another value (e.g. \"no\") the box will be collapsed by default (its contents hidden).",
			"type": "string",
			"default": "no"
		},
		"border": {
			"label": "Border width",
			"description": "Width of the outermost border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
			"type": "string",
			"default": "1px"
		},
		"bg": {
			"label": "Title bar's color",
			"description": "Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.",
			"type": "string",
			"aliases": [
				"background"
			],
			"default": "#F0F2F5"
		},
		"padding": {
			"label": "Padding",
			"description": "Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. \"px\") Example: 2px.",
			"default": "8px"
		},
		"bg1": {
			"label": "Outer background",
			"description": "Color of the space between the inner and outer border. Can be set to any valid CSS color.",
			"type": "string",
			"default": "transparent"
		},
		"b-color": {
			"label": "Outer border color",
			"description": "Color of the outer border. Can be any valid CSS color.",
			"type": "string",
			"default": "silver"
		},
		"width": {
			"label": "Collapse box width",
			"description": "The width of the entire collapsed box.",
			"type": "string",
			"default": "100%"
		},
		"center": {
			"label": "Center-align title",
			"description": "If set to any value, the title will be centered.",
			"type": "boolean"
		},
		"fc": {
			"label": "Font color",
			"description": "Font color for the title. Also sets the color of the [show]/[hide] link. Can be any valid CSS color",
			"type": "string"
		},
		"class": {
			"label": "CSS class",
			"description": "Additional CSS class to add",
			"type": "string"
		},
		"float": {
			"label": "CSS float",
			"description": "CSS float, one of \"left\", \"right\", \"none\", \"center\"/\"centre\", or blank.",
			"type": "string"
		},
		"clear": {
			"label": "CSS clear",
			"description": "CSS clear value.  The default depends on the selected float.  Usually one of \"none\", \"left\", \"right\", or \"both\"",
			"type": "string"
		},
		"left": {
			"label": "Left-align title",
			"description": "Left-aligns the title.  Takes precedence over center.",
			"type": "boolean"
		},
		"border2": {
			"label": "Content border",
			"description": "CSS border styling to add to the content.",
			"type": "string",
			"default": "1px silver"
		},
		"bg2": {
			"label": "Content background color",
			"description": "Background color to use for expanded content.",
			"type": "string",
			"default": "white"
		}
	}
}
</templatedata>

== Re-using at other wikis ==
This template depends upon having rules for the three classes (collapsible, uncollapsed, and collapsed) in the appropriate CSS files, and some related JavaScript installed. This template transcludes {{tl|main other}} and {{tl|lorem ipsum}}, which should also be imported at the same time.

For MediaWiki versions ≥ 1.18, this template can simply be exported and then imported into another MediaWiki installation. Changes to the source code that will need to be made are:
:* <code>class="collapsible</code> needs to be changed to <code>class="mw-collapsible</code> (probably because the class had apparently been deprecated since ''MediaWiki v1.20'').
:* <code>|#default=collapsed}}</code> changed to <code>|#default=mw-collapsed}}</code>.
:* Some additional changes to the source code will need to be made in order for this template to become usable on the Main/Article (ns:0) [[mw:Help:Namespaces|namespace]].

The toggle text can be edited at external Wiki's [[MediaWiki:Collapsible-expand]] and [[MediaWiki:Collapsible-collapse]] pages. Further information at [[mw:ResourceLoader/Modules#jquery.makeCollapsible|jquery.makeCollapsible module]].

== See also ==
* {{Tl|collapse top}}
* {{Tl|collapse bottom}}
* {{tl|discussion top}}
* {{tl|archive top}}
* {{tl|hidden archive top}}

<includeonly>
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Archival templates|{{PAGENAME}}]]
[[Category:Collapse templates|{{PAGENAME}}]]

</includeonly>