Template:Collapse top

<languages/>

{{#if: | }}

<translate> Extended content</translate>
<translate> The following is a closed debate.</translate> Template:Strong
<translate> The following content has been placed in a collapsed box for improved usability.</translate>

{{#if:<translate> The <tvar name=1>{{Collapse top}}</tvar> template, and its paired template <tvar name=2>{{Collapse bottom}}</tvar>, are used for placing a collapse box around a talk page discussion.

Usage

</translate> <translate> Place <tvar name=1>{{Collapse top}}</tvar> and <tvar name=2>{{Collapse bottom}}</tvar> around the text to be collapsed.</translate> <translate> For example:</translate>

<syntaxhighlight lang="wikitext">

{{#if: | }}

<translate nowrap> This is the title text</translate>
<translate> The following is a closed debate.</translate> Template:Strong
<translate nowrap> Sample contents text</translate>

</syntaxhighlight>

<translate> produces: </translate>

{{#if: | }}

<translate> This is the title text</translate>
<translate> The following is a closed debate.</translate> Template:Strong
<translate> Sample contents text</translate>

<translate> <tvar name=1>{{Collapse bottom}}</tvar> should always be placed on its own line.

Parameters

</translate> <translate> This template takes the following parameters, all of which are optional.</translate> <translate> They are case-sensitive.</translate> <translate> Those that take CSS measurements require them in CSS format (e.g. <tvar name=1>1em</tvar> not <tvar name=2>1 em</tvar>).</translate>

|{{SAFESUBST:#if:1|1=}} <translate> (or first unnamed parameter)</translate>, |{{SAFESUBST:#if:title|title=}}, |{{SAFESUBST:#if:reason|reason=}}, |{{SAFESUBST:#if:header|header=}}, |{{SAFESUBST:#if:heading|heading=}}

<translate> Will give the collapsed box a title, which occurs on the same line as the show link and is always visible.</translate> <translate> It defaults to "Extended content".</translate>

<translate> For example, <tvar name=1>{{Collapse top|title=This is the title text}}</tvar> or <tvar name=2>{{Collapse top|This is the title text}}</tvar>.</translate> <translate> Note: The shorter, unnamed markup will not work if the title value contain an equals (<tvar name=1>=</tvar>) character.</translate>

|{{SAFESUBST:#if:warning|warning=}}yes

<translate> Will display a default warning line under the main title which reads "The following is a closed debate. {{<tvar name=1>Strong|style=color:red</tvar>|Please do not modify it.}}"</translate>

<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|{{SAFESUBST:#if:warning|warning=}}</tvar> will not work as expected).</translate>

|{{SAFESUBST:#if:2|2=}} <translate> (or second unnamed parameter)</translate>

<translate> This is optional warning-line text.</translate> <translate> It will override the standard warning line above; it is not necessary to also use <tvar name=1>|{{SAFESUBST:#if:warning|warning=}}yes</tvar> in this case, though doing so is harmless.</translate>

|{{SAFESUBST:#if:left|left=}}yes

<translate> Will align the title along the left margin (in RTL languages, along the right margin instead).</translate>

<translate> By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.</translate>

<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|{{SAFESUBST:#if:left|left=}}</tvar> will not work as expected).</translate>

|{{SAFESUBST:#if:expand|expand=}}yes

<translate> Will leave the material uncollapsed with the border and coloring.</translate> <translate> Default is to collapse the material.</translate>

<translate> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>|{{SAFESUBST:#if:expand|expand=}}</tvar> will not work as expected).</translate>

|{{SAFESUBST:#if:bg|bg=}}

<translate> Sets the background color of the title of the collapsible bar.</translate> <translate> Defaults to "<tvar name=1>#F8FCFF</tvar>", a whitish color.</translate> <translate> Named colors are listed at List of colors.</translate>

<translate> For example, <tvar name=1>{{Collapse top|This is the title text|bg=#008000}}</tvar> or <tvar name=2>{{Collapse top|This is the title text|bg=green}}</tvar> (numeric HTML color codes require the leading <tvar name=H>#</tvar>).</translate>

|{{SAFESUBST:#if:fc|fc=}}

<translate> Sets the font color of the title of the collapsible bar.</translate> <translate> Defaults to "<tvar name=1>black</tvar>".</translate>

<translate> See <tvar name=bg>|{{SAFESUBST:#if:bg|bg=}}</tvar>, above, for details on color options.</translate>

|{{SAFESUBST:#if:border|border=}}

<translate> Sets the width of the border line on the collapsed material.</translate> <translate> Defaults to <tvar name=1>1px</tvar>.</translate>

<translate> For example, <tvar name=1>{{Collapse top|border=2px}}</tvar>; going much thicker than this is not very useful.</translate>

|{{SAFESUBST:#if:b-color|b-color=}}

<translate> Sets the border color.</translate> <translate> Defaults to <tvar name=1>silver</tvar> (<tvar name=2>#C0C0C0</tvar>).</translate>

<translate> See <tvar name=bg>|{{SAFESUBST:#if:bg|bg=}}</tvar>, above, for details on color options.</translate>

|{{SAFESUBST:#if:padding|padding=}}

<translate> Sets the padding (distance from borders) on the collapsed material inside the colored area.</translate> <translate> Defaults to <tvar name=1>8px</tvar>.</translate>

|{{SAFESUBST:#if:width|width=}}

<translate> Sets the width of the overall template relative to the page (or a block element containing the collapse box).</translate> <translate> This should virtually always be given as a percentage, e.g. <tvar name=1>|{{SAFESUBST:#if:width|width=}}50%</tvar>, or in relative <tvar name=2>em</tvar> units, e.g. <tvar name=3>|{{SAFESUBST:#if:width|width=}}30em</tvar>.</translate> <translate> 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.).</translate>

|{{SAFESUBST:#if:border2|border2=}}

<translate> Sets the properties of the border of the box that appears when template is expanded.</translate> <translate> Defaults to <tvar name=1>1px silver</tvar> (there is no provision to change from a solid line).</translate>

<translate> For example, <tvar name=1>{{Collapse top|border2=2px}}</tvar> (only width or color will be changed if only one value is supplied).</translate>

<translate> See <tvar name=bg>|{{SAFESUBST:#if:bg|bg=}}</tvar>, above, for details on color options.</translate>

|{{SAFESUBST:#if:bg2|bg2=}}

<translate> Sets the background color of the box that appears when template is expanded; defaults to <tvar name=1>white</tvar> (<tvar name=2>#FFF</tvar>).</translate>

<translate> See <tvar name=bg>|{{SAFESUBST:#if:bg|bg=}}</tvar>, above, for details on color options.</translate>

|{{SAFESUBST:#if:indent|indent=}}

<translate> Indents the box from the left of the page.</translate> <translate> Defaults to no indentation.</translate> <translate> Each <tvar name=1>:</tvar> in talk page markup is approximately equivalent to <tvar name=2>1.6em</tvar> of indent (e.g., to match <tvar name=3>::::</tvar> indentation level, use <tvar name=4>|{{SAFESUBST:#if:indent|indent=}}6.4em</tvar>).</translate> <translate> You can also use a percentage value.</translate>

<translate> Pixel-based values should be avoided (see <tvar name=1>|{{SAFESUBST:#if:width|width=}}</tvar>, above, for the reason).</translate>

<translate>

Examples

</translate>

• <translate> Adding a box title (if omitted, default is "Extended content")</translate> – <syntaxhighlight lang="wikitext" inline>
  {{#if: | }}

  This is the title text
  <translate> The following is a closed debate.</translate> Template:Strong
  </syntaxhighlight> {{#if: | }} This is the title text <translate> The following is a closed debate.</translate> Template:Strong <translate> Adding a standard warning line</translate> – <syntaxhighlight lang="wikitext" inline> {{#if:true | }} This is the title text <translate> The following is a closed debate.</translate> Template:Strong </syntaxhighlight> {{#if:true | }} This is the title text <translate> The following is a closed debate.</translate> Template:Strong <translate> Adding a custom warning line</translate> – <syntaxhighlight lang="wikitext" inline> {{#if:This is a custom warning line | }} This is the title text This is a custom warning line </syntaxhighlight> {{#if:This is a custom warning line | }} This is the title text This is a custom warning line <translate> Aligning box title along left margin</translate> – <syntaxhighlight lang="wikitext" inline> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong </syntaxhighlight> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong <translate> Changing background color</translate> – <syntaxhighlight lang="wikitext" inline> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong </syntaxhighlight> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong <translate> Adding extra padding</translate> – <syntaxhighlight lang="wikitext" inline> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong </syntaxhighlight> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong <translate> Archiving a section</translate> – <translate> The markup below:</translate> <syntaxhighlight lang="wikitext"> {{#if: | }} <translate> Extended content</translate> <translate> The following is a closed debate.</translate> Template:Strong Section header Sample contents text </syntaxhighlight> <translate> must be rewritten as: </translate> <syntaxhighlight lang="wikitext"> {{#if: | }} Section header <translate> The following is a closed debate.</translate> Template:Strong Sample contents text </syntaxhighlight> <translate> The end result: </translate> {{#if: | }} Section header <translate> The following is a closed debate.</translate> Template:Strong Sample contents text <translate> TemplateData </translate> Template:Collapse top/doc <translate> See also </translate> {{Collapse bottom}} {{Hidden archive top}} and {{Hidden archive bottom}} {{Hidden begin}} and {{Hidden end}} {{Hidden}}} [[Category:Formatting templates{{#translation:}}]]| [[Category:Template documentation pages{{#translation:}}]] }}