Difference between revisions of "Template:Collapse top"

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

<translate><!--T:13--> Place <tvar name=1>{{Tlx|Collapse top}}</tvar> and <tvar name=2>{{Tlx|Collapse bottom}}</tvar> around the text to be collapsed.</translate>

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

<translate><!--T:19--> Those that take CSS measurements require them in CSS format (e.g. <tvar name=1><code style="color: #006400">1em</code></tvar> not <tvar name=2><code style="color:#8B0000">1&nbsp;em</code></tvar>).</translate>

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

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

: <translate><!--T:27--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|warning|<span style="color:red">no</span>}}</tvar> will not work as expected).</translate>

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

: <translate><!--T:33--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|left|<span style="color:#8B0000">no</span>}}</tvar> will not work as expected).</translate>

: <translate><!--T:36--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar name=1>{{Para|expand|<span style="color:#8B0000">no</span>}}</tvar> will not work as expected).</translate>

: <translate><!--T:37--> Sets the background color of the title of the collapsible bar.</translate> <translate><!--T:38--> Defaults to "<tvar name=1>#F8FCFF</tvar>", a whitish color.</translate> <translate><!--T:39--> Named colors are listed at [[List of colors]].</translate>

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

: <translate><!--T:41--> Sets the font color of the title of the collapsible bar.</translate> <translate><!--T:42--> Defaults to "<tvar name=1>black</tvar>".</translate>

: <translate><!--T:43--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>

: <translate><!--T:44--> Sets the width of the border line on the collapsed material.</translate> <translate><!--T:45--> Defaults to <tvar name=1><code>1px</code></tvar>.</translate>

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

: <translate><!--T:47--> Sets the border color.</translate> <translate><!--T:48--> Defaults to <tvar name=1><code>silver</code></tvar> (<tvar name=2><code>#C0C0C0</code></tvar>).</translate>

: <translate><!--T:49--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>

: <translate><!--T:50--> Sets the padding (distance from borders) on the collapsed material inside the colored area.</translate> <translate><!--T:51--> Defaults to <tvar name=1><code>8px</code></tvar>.</translate>

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

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

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

: <translate><!--T:58--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>

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

: <translate><!--T:60--> See <tvar name=bg>{{Para|bg}}</tvar>, above, for details on color options.</translate>

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

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