Редактирование: Шаблон:Collapse/doc

{{Documentation subpage}}
{{High-use|1,800+}}

{{shortcut|Template:Cot|Template:Cob}}

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 [[Wikipedia:refactoring]] guideline; it should never be used 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 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; [[Help:Section|Heading]] &#x3d;&#x3d;<br />{{Lorem ipsum}}
|}

Replace with:

<code>{{Tlsp|Collapse|1&#61;{{Lorem ipsum}}|2&#61;[[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. Other options: {{para|expand|}} <code>yes, y, expand, expanded, uncollapse, uncollapsed</code>. Note: {{para|expand|no}} will fold the box (default).

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

==TemplateData==
{{TemplateDataHeader}}
<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
		},
		"2": {
			"label": "Title",
			"description": "Text of title bar. Defaults to \"Extended contents\".",
			"type": "string",
			"suggested": true
		},
		"expand": {
			"label": "Expanded by default?",
			"description": "Setting to \"yes, y, expand, uncollapse\") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be collapsed by default (its contents hidden).",
			"type": "string",
			"default": "yes"
		},
		"border": {
			"label": "Border width",
			"description": "Width of the 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"
		},
		"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"
		}
	}
}
</templatedata>

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