Difference between revisions of "Template:Collapse top/en"
Jump to navigation
Jump to search
>FuzzyBot (Updating to match new version of source page) |
>FuzzyBot (Updating to match new version of source page) |
||
| Line 24: | Line 24: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
{{Documentation|content= | {{Documentation|content= | ||
The {{Tlx|Collapse top}} template, and its paired template {{Tlx|Collapse bottom}}, are used for placing a collapse box around a talk page discussion. | The {{Tlx|Collapse top}} template, and its paired template {{Tlx|Collapse bottom}}, are used for placing a collapse box around a talk page discussion. | ||
== Usage == | == Usage == | ||
Place {{Tlx|Collapse top}} and {{Tlx|Collapse bottom}} around the text to be collapsed. | |||
For example: | |||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
| Line 38: | Line 36: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
produces: | produces: | ||
{{Collapse top|title=This is the title text}} | {{Collapse top|title=This is the title text}} | ||
| Line 46: | Line 42: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
{{Tlx|Collapse bottom}} should always be placed on its own line. | {{Tlx|Collapse bottom}} should always be placed on its own line. | ||
== Parameters == | == Parameters == | ||
This template takes the following parameters, all of which are optional. | |||
They are case-sensitive. | |||
Those that take CSS measurements require them in CSS format (e.g. <code style="color: #006400">1em</code> not <code style="color:#8B0000">1 em</code>. | |||
; {{Para|1}} <span style="font-weight:normal | ; {{Para|1}} <span style="font-weight:normal">(or first unnamed parameter)</span>, {{Para|title}}, {{Para|reason}}, {{Para|header}}, {{Para|heading}} | ||
: | : Will give the collapsed box a title, which occurs on the same line as the ''show'' link and is always visible. It defaults to "Extended content". | ||
: | : For example, <code><nowiki>{{Collapse top|title=This is the title text}}</nowiki></code> or <code><nowiki>{{Collapse top|This is the title text}}</nowiki></code>. Note: The shorter, unnamed markup will not work if the title value contain an equals (<code>=</code>) character. | ||
; {{Para|warning|yes}} | ; {{Para|warning|yes}} | ||
: | : Will display a default warning line under the main title which reads "The following is a closed debate. {{Strong|style=color:red|Please do not modify it.}}" | ||
: | : Any non-empty value supplied to this parameter will have this effect (i.e. {{Para|warning|<span style="color:red">no</span>}} will not work as expected). | ||
; {{Para|2}} <span style="font-weight:normal | ; {{Para|2}} <span style="font-weight:normal">(or second unnamed parameter)</span> | ||
: | : This is optional warning-line text. It will override the standard warning line above; it is not necessary to also use {{Para|warning|yes}} in this case, though doing so is harmless. | ||
; {{Para|left|yes}} | ; {{Para|left|yes}} | ||
: | : Will align the title along the left margin (in RTL languages, along the right margin instead). | ||
: | : By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link. | ||
: | : Any non-empty value supplied to this parameter will have this effect (i.e. {{Para|left|<span style="color:#8B0000">no</span>}} will not work as expected). | ||
; {{Para|expand|yes}} | ; {{Para|expand|yes}} | ||
: | : Will leave the material uncollapsed with the border and coloring. Default is to collapse the material. | ||
: | : Any non-empty value supplied to this parameter will have this effect (i.e. {{Para|expand|<span style="color:#8B0000">no</span>}} will not work as expected). | ||
; {{Para|bg}} | ; {{Para|bg}} | ||
: | : Sets the background color of the title of the collapsible bar. Defaults to "#F8FCFF", a whitish color. Named colors are listed at [[List of colors]]. | ||
: | : For example, <code><nowiki>{{Collapse top|This is the title text|bg=#008000}}</nowiki></code> or <code><nowiki>{{Collapse top|This is the title text|bg=green}}</nowiki></code> (numeric HTML color codes require the leading <code>#</code>). | ||
; {{Para|fc}} | ; {{Para|fc}} | ||
: | : Sets the font color of the title of the collapsible bar. Defaults to "black". | ||
: | : See {{Para|bg}}, above, for details on color options. | ||
; {{Para|border}} | ; {{Para|border}} | ||
: | : Sets the width of the border line on the collapsed material. Defaults to <code>1px</code>. | ||
: | : For example, <code><nowiki>{{Collapse top|border=2px}}</nowiki></code>; going much thicker than this is not very useful. | ||
; {{Para|b-color}} | ; {{Para|b-color}} | ||
: | : Sets the border color. Defaults to <code>silver</code> (<code>#C0C0C0</code>). | ||
: | : See {{Para|bg}}, above, for details on color options. | ||
; {{Para|padding}} | ; {{Para|padding}} | ||
: | : Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>8px</code>. | ||
; {{Para|width}} | ; {{Para|width}} | ||
: | : Sets the width of the overall template relative to the page (or a block element containing the collapse box). This should virtually always be given as a percentage, e.g. {{Para|width|50%}}, or in relative <code>em</code> units, e.g. {{Para|width|30em}}. 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.). | ||
; {{Para|border2}} | ; {{Para|border2}} | ||
: | : Sets the properties of the border of the box that appears when template is expanded. Defaults to <code>1px silver</code> (there is no provision to change from a solid line). | ||
: | : For example, <code><nowiki>{{Collapse top|border2=2px}}</nowiki></code> (only width or color will be changed if only one value is supplied). | ||
: | : See {{Para|bg}}, above, for details on color options. | ||
; {{Para|bg2}} | ; {{Para|bg2}} | ||
: | : Sets the background color of the box that appears when template is expanded; defaults to <code>white</code> (<code>#FFF</code>). | ||
: | : See {{Para|bg}}, above, for details on color options. | ||
; {{Para|indent}} | ; {{Para|indent}} | ||
: | : Indents the box from the left of the page. Defaults to no indentation. Each <code>:</code> in talk page markup is approximately equivalent to <code>1.6em</code> of indent (e.g., to match <code>::::</code> indentation level, use {{Para|indent|6.4em}}. You can also use a percentage value. | ||
: | : Pixel-based values should be avoided (see {{Para|width}}, above, for the reason). | ||
== Examples == | == Examples == | ||
* | * Adding a box title (if omitted, default is "Extended content") – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text}}</syntaxhighlight> | ||
{{Collapse top|This is the title text}} | {{Collapse top|This is the title text}} | ||
| Line 104: | Line 98: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Adding a standard warning line – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|warning=true}}</syntaxhighlight> | ||
{{Collapse top|This is the title text|warning=true}} | {{Collapse top|This is the title text|warning=true}} | ||
| Line 110: | Line 104: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Adding a custom warning line – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|This is a custom warning line}}</syntaxhighlight> | ||
{{Collapse top|This is the title text|This is a custom warning line}} | {{Collapse top|This is the title text|This is a custom warning line}} | ||
| Line 116: | Line 110: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Aligning box title along left margin – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight> | ||
{{Collapse top|left=true}} | {{Collapse top|left=true}} | ||
| Line 122: | Line 116: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Changing background color – <syntaxhighlight lang="html5" inline>{{Collapse top|bg=#F0F2F5}}</syntaxhighlight> | ||
{{Collapse top|bg=#F0F2F5}} | {{Collapse top|bg=#F0F2F5}} | ||
| Line 128: | Line 122: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Adding extra padding – <syntaxhighlight lang="html5" inline>{{Collapse top|padding=5em}}</syntaxhighlight> | ||
{{Collapse top|padding=5em}} | {{Collapse top|padding=5em}} | ||
| Line 134: | Line 128: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* | * Archiving a section – The markup below: | ||
<syntaxhighlight lang="html5">{{Collapse top}} | <syntaxhighlight lang="html5">{{Collapse top}} | ||
| Line 141: | Line 135: | ||
{{Collapse bottom}}</syntaxhighlight> | {{Collapse bottom}}</syntaxhighlight> | ||
must be rewritten as: | must be rewritten as: | ||
<syntaxhighlight lang="html5">{{Collapse top|Section header}} | <syntaxhighlight lang="html5">{{Collapse top|Section header}} | ||
| Line 149: | Line 141: | ||
{{Collapse bottom}}</syntaxhighlight> | {{Collapse bottom}}</syntaxhighlight> | ||
The end result: | The end result: | ||
{{Collapse top|Section header}} | {{Collapse top|Section header}} | ||
| Line 157: | Line 147: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
== TemplateData == | == TemplateData == | ||
{{Collapse top/doc}} | {{Collapse top/doc}} | ||
Revision as of 02:42, 8 November 2020
<languages />
| Extended content |
|---|
|
The following content has been placed in a collapsed box for improved usability.
|
Lua error in Module:TNT at line 158: Missing JsonConfig extension; Cannot load https://commons.wikimedia.org/wiki/Data:I18n/Documentation.tab.[[Category:Template documentation pages{{#translation:}}]]