View source for Template:Collapse/doc View history

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Template doc cleanup}}

{{Mbox
| type = construction
| text = This documentation is not fully updated to match the current ability of the template. Details can be found in the current version of the [https://en.wikipedia.org/wiki/Template:Collapse Wikipedia Template:Collapse] doc.
}}

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

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

=== The bg parameter ===

The bg parameter is optional. It changes the background color. Use [[web color]] values (e.g. #F0F2F5).

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

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

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

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

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

=== 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; [[Wikipedia:Help:Section|Heading]] &#x3d;&#x3d;<br />{{Lorem ipsum}}
|}

Replace with:

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

===The expand 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.  Note: {{para|expand|no}} does not work; to disable the feature, you have to remove the entire {{para||expand}} parameter and value.

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

== See also ==
* {{Tl|collapse top}}
* {{Tl|collapse bottom}}

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

</includeonly>