View source for Template:Collapse/doc

{{Documentation subpage}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{shortcut|Template:Cot|Template:Cob}}

The Collapse template is used for placing collapse boxes around ''short'' discussions and bits of discussions (tables, long code samples, etc.).  For entire discussion threads, use {{tl|Collapse top}} and {{tl|Collapse bottom}} instead.

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

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

{{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:

{{Divbox|green|Example text|&#x3d;&#x3d; [[Help:Section|Heading]] &#x3d;&#x3d;<br />{{Lorem ipsum}}}}

Replace with:

{{Divbox|tt|Changed to|{{Tlsp|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[Help:Section|Heading]]}}}}

===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, which is lame; to disable the feature, you have to remove the entire {{para||expand}} parameter and value.

== 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}}]]

[[hu:Sablon:Doboz2]]
</includeonly>