Difference between revisions of "Template:Collapse top"
Jump to navigation
Jump to search
>Shirayuki (translation tweaks) |
>Shirayuki (Marked this version for translation) |
||
| Line 25: | Line 25: | ||
{{Documentation|content= | {{Documentation|content= | ||
<translate> | <translate> | ||
<!--T:12--> | |||
The <tvar|1>{{Tlx|Collapse top}}</> template, and its paired template <tvar|2>{{Tlx|Collapse bottom}}</>, are used for placing a collapse box around a talk page discussion. | The <tvar|1>{{Tlx|Collapse top}}</> template, and its paired template <tvar|2>{{Tlx|Collapse bottom}}</>, are used for placing a collapse box around a talk page discussion. | ||
== Usage == <!--T:8--> | == Usage == <!--T:8--> | ||
</translate> | </translate> | ||
<translate>Place <tvar|1>{{Tlx|Collapse top}}</> and <tvar|2>{{Tlx|Collapse bottom}}</> around the text to be collapsed.</translate> | <translate><!--T:13--> Place <tvar|1>{{Tlx|Collapse top}}</> and <tvar|2>{{Tlx|Collapse bottom}}</> around the text to be collapsed.</translate> | ||
<translate>For example:</translate> | <translate><!--T:14--> For example:</translate> | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
| Line 39: | Line 40: | ||
<translate> | <translate> | ||
<!--T:15--> | |||
produces: | produces: | ||
</translate> | </translate> | ||
| Line 47: | Line 49: | ||
<translate> | <translate> | ||
<!--T:16--> | |||
<tvar|1>{{Tlx|Collapse bottom}}</> should always be placed on its own line. | <tvar|1>{{Tlx|Collapse bottom}}</> should always be placed on its own line. | ||
== Parameters == <!--T:9--> | == Parameters == <!--T:9--> | ||
</translate> | </translate> | ||
<translate>This template takes the following parameters, all of which are optional.</translate> | <translate><!--T:17--> This template takes the following parameters, all of which are optional.</translate> | ||
<translate>They are case-sensitive.</translate> | <translate><!--T:18--> They are case-sensitive.</translate> | ||
<translate>Those that take CSS measurements require them in CSS format (e.g. <tvar|1><code style="color: #006400">1em</code></> not <tvar|2><code style="color:#8B0000">1 em</code></>.</translate> | <translate><!--T:19--> Those that take CSS measurements require them in CSS format (e.g. <tvar|1><code style="color: #006400">1em</code></> not <tvar|2><code style="color:#8B0000">1 em</code></>.</translate> | ||
; {{Para|1}} <span style="font-weight:normal"><translate>(or first unnamed parameter)</translate></span>, {{Para|title}}, {{Para|reason}}, {{Para|header}}, {{Para|heading}} | ; {{Para|1}} <span style="font-weight:normal"><translate><!--T:20--> (or first unnamed parameter)</translate></span>, {{Para|title}}, {{Para|reason}}, {{Para|header}}, {{Para|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><!--T:21--> Will give the collapsed box a title, which occurs on the same line as the ''show'' link and is always visible.</translate> <translate><!--T:22--> It defaults to "Extended content".</translate> | ||
: <translate>For example, <tvar|1><code><nowiki>{{Collapse top|title=This is the title text}}</nowiki></code></> or <tvar|2><code><nowiki>{{Collapse top|This is the title text}}</nowiki></code></>.</translate> <translate>Note: The shorter, unnamed markup will not work if the title value contain an equals (<tvar|1><code>=</code></>) character.</translate> | : <translate><!--T:23--> For example, <tvar|1><code><nowiki>{{Collapse top|title=This is the title text}}</nowiki></code></> or <tvar|2><code><nowiki>{{Collapse top|This is the title text}}</nowiki></code></>.</translate> <translate><!--T:24--> Note: The shorter, unnamed markup will not work if the title value contain an equals (<tvar|1><code>=</code></>) character.</translate> | ||
; {{Para|warning|yes}} | ; {{Para|warning|yes}} | ||
: <translate>Will display a default warning line under the main title which reads "The following is a closed debate.</translate> <translate>{{<tvar|1>Strong|style=color:red</>|Please do not modify it.}}"</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|1>Strong|style=color:red</>|Please do not modify it.}}"</translate> | ||
: <translate>Any non-empty value supplied to this parameter will have this effect (i.e. <tvar|1>{{Para|warning|<span style="color:red">no</span>}}</> will not work as expected).</translate> | : <translate><!--T:27--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar|1>{{Para|warning|<span style="color:red">no</span>}}</> will not work as expected).</translate> | ||
; {{Para|2}} <span style="font-weight:normal"><translate>(or second unnamed parameter)</translate></span> | ; {{Para|2}} <span style="font-weight:normal"><translate><!--T:28--> (or second unnamed parameter)</translate></span> | ||
: <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|1>{{Para|warning|yes}}</> in this case, though doing so is harmless.</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|1>{{Para|warning|yes}}</> in this case, though doing so is harmless.</translate> | ||
; {{Para|left|yes}} | ; {{Para|left|yes}} | ||
: <translate>Will align the title along the left margin (in RTL languages, along the right margin instead).</translate> | : <translate><!--T:31--> 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><!--T:32--> 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|1>{{Para|left|<span style="color:#8B0000">no</span>}}</> will not work as expected).</translate> | : <translate><!--T:33--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar|1>{{Para|left|<span style="color:#8B0000">no</span>}}</> will not work as expected).</translate> | ||
; {{Para|expand|yes}} | ; {{Para|expand|yes}} | ||
: <translate>Will leave the material uncollapsed with the border and coloring.</translate> <translate>Default is to collapse the material.</translate> | : <translate><!--T:34--> Will leave the material uncollapsed with the border and coloring.</translate> <translate><!--T:35--> Default is to collapse the material.</translate> | ||
: <translate>Any non-empty value supplied to this parameter will have this effect (i.e. <tvar|1>{{Para|expand|<span style="color:#8B0000">no</span>}}</> will not work as expected).</translate> | : <translate><!--T:36--> Any non-empty value supplied to this parameter will have this effect (i.e. <tvar|1>{{Para|expand|<span style="color:#8B0000">no</span>}}</> will not work as expected).</translate> | ||
; {{Para|bg}} | ; {{Para|bg}} | ||
: <translate>Sets the background color of the title of the collapsible bar.</translate> <translate>Defaults to "<tvar|1>#F8FCFF</>", a whitish color.</translate> <translate>Named colors are listed at [[List of colors]].</translate> | : <translate><!--T:37--> Sets the background color of the title of the collapsible bar.</translate> <translate><!--T:38--> Defaults to "<tvar|1>#F8FCFF</>", a whitish color.</translate> <translate><!--T:39--> Named colors are listed at [[List of colors]].</translate> | ||
: <translate>For example, <tvar|1><code><nowiki>{{Collapse top|This is the title text|bg=#008000}}</nowiki></code></> or <tvar|2><code><nowiki>{{Collapse top|This is the title text|bg=green}}</nowiki></code></> (numeric HTML color codes require the leading <tvar|H><code>#</code></>).</translate> | : <translate><!--T:40--> For example, <tvar|1><code><nowiki>{{Collapse top|This is the title text|bg=#008000}}</nowiki></code></> or <tvar|2><code><nowiki>{{Collapse top|This is the title text|bg=green}}</nowiki></code></> (numeric HTML color codes require the leading <tvar|H><code>#</code></>).</translate> | ||
; {{Para|fc}} | ; {{Para|fc}} | ||
: <translate>Sets the font color of the title of the collapsible bar.</translate> <translate>Defaults to "<tvar|1>black</>".</translate> | : <translate><!--T:41--> Sets the font color of the title of the collapsible bar.</translate> <translate><!--T:42--> Defaults to "<tvar|1>black</>".</translate> | ||
: <translate>See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | : <translate><!--T:43--> See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | ||
; {{Para|border}} | ; {{Para|border}} | ||
: <translate>Sets the width of the border line on the collapsed material.</translate> <translate>Defaults to <tvar|1><code>1px</code></>.</translate> | : <translate><!--T:44--> Sets the width of the border line on the collapsed material.</translate> <translate><!--T:45--> Defaults to <tvar|1><code>1px</code></>.</translate> | ||
: <translate>For example, <tvar|1><code><nowiki>{{Collapse top|border=2px}}</nowiki></code></>; going much thicker than this is not very useful.</translate> | : <translate><!--T:46--> For example, <tvar|1><code><nowiki>{{Collapse top|border=2px}}</nowiki></code></>; going much thicker than this is not very useful.</translate> | ||
; {{Para|b-color}} | ; {{Para|b-color}} | ||
: <translate>Sets the border color.</translate> <translate>Defaults to <tvar|1><code>silver</code></> (<tvar|2><code>#C0C0C0</code></>).</translate> | : <translate><!--T:47--> Sets the border color.</translate> <translate><!--T:48--> Defaults to <tvar|1><code>silver</code></> (<tvar|2><code>#C0C0C0</code></>).</translate> | ||
: <translate>See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | : <translate><!--T:49--> See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | ||
; {{Para|padding}} | ; {{Para|padding}} | ||
: <translate>Sets the padding (distance from borders) on the collapsed material inside the colored area.</translate> <translate>Defaults to <tvar|1><code>8px</code></>.</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|1><code>8px</code></>.</translate> | ||
; {{Para|width}} | ; {{Para|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|1>{{Para|width|50%}}</>, or in relative <tvar|2><code>em</code></> units, e.g. <tvar|3>{{Para|width|30em}}</>.</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> | : <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|1>{{Para|width|50%}}</>, or in relative <tvar|2><code>em</code></> units, e.g. <tvar|3>{{Para|width|30em}}</>.</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> | ||
; {{Para|border2}} | ; {{Para|border2}} | ||
: <translate>Sets the properties of the border of the box that appears when template is expanded.</translate> <translate>Defaults to <tvar|1><code>1px silver</code></> (there is no provision to change from a solid line).</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|1><code>1px silver</code></> (there is no provision to change from a solid line).</translate> | ||
: <translate>For example, <tvar|1><code><nowiki>{{Collapse top|border2=2px}}</nowiki></code></> (only width or color will be changed if only one value is supplied).</translate> | : <translate><!--T:57--> For example, <tvar|1><code><nowiki>{{Collapse top|border2=2px}}</nowiki></code></> (only width or color will be changed if only one value is supplied).</translate> | ||
: <translate>See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | : <translate><!--T:58--> See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | ||
; {{Para|bg2}} | ; {{Para|bg2}} | ||
: <translate>Sets the background color of the box that appears when template is expanded; defaults to <tvar|1><code>white</code></> (<tvar|2><code>#FFF</code></>).</translate> | : <translate><!--T:59--> Sets the background color of the box that appears when template is expanded; defaults to <tvar|1><code>white</code></> (<tvar|2><code>#FFF</code></>).</translate> | ||
: <translate>See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | : <translate><!--T:60--> See <tvar|bg>{{Para|bg}}</>, above, for details on color options.</translate> | ||
; {{Para|indent}} | ; {{Para|indent}} | ||
: <translate>Indents the box from the left of the page.</translate> <translate>Defaults to no indentation.</translate> <translate>Each <tvar|1><code>:</code></> in talk page markup is approximately equivalent to <tvar|2><code>1.6em</code></> of indent (e.g., to match <tvar|3><code>::::</code></> indentation level, use <tvar|4>{{Para|indent|6.4em}}</>.</translate> <translate>You can also use a percentage value.</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|1><code>:</code></> in talk page markup is approximately equivalent to <tvar|2><code>1.6em</code></> of indent (e.g., to match <tvar|3><code>::::</code></> indentation level, use <tvar|4>{{Para|indent|6.4em}}</>.</translate> <translate><!--T:64--> You can also use a percentage value.</translate> | ||
: <translate>Pixel-based values should be avoided (see <tvar|1>{{Para|width}}</>, above, for the reason).</translate> | : <translate><!--T:65--> Pixel-based values should be avoided (see <tvar|1>{{Para|width}}</>, above, for the reason).</translate> | ||
<translate> | <translate> | ||
== Examples == <!--T:10--> | == Examples == <!--T:10--> | ||
</translate> | </translate> | ||
* <translate>Adding a box title (if omitted, default is "Extended content")</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text}}</syntaxhighlight> | * <translate><!--T:66--> Adding a box title (if omitted, default is "Extended content")</translate> – <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 106: | Line 109: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Adding a standard warning line</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|warning=true}}</syntaxhighlight> | * <translate><!--T:67--> Adding a standard warning line</translate> – <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 112: | Line 115: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Adding a custom warning line</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|This is a custom warning line}}</syntaxhighlight> | * <translate><!--T:68--> Adding a custom warning line</translate> – <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 118: | Line 121: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Aligning box title along left margin</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight> | * <translate><!--T:69--> Aligning box title along left margin</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight> | ||
{{Collapse top|left=true}} | {{Collapse top|left=true}} | ||
| Line 124: | Line 127: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Changing background color</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|bg=#F0F2F5}}</syntaxhighlight> | * <translate><!--T:70--> Changing background color</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|bg=#F0F2F5}}</syntaxhighlight> | ||
{{Collapse top|bg=#F0F2F5}} | {{Collapse top|bg=#F0F2F5}} | ||
| Line 130: | Line 133: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Adding extra padding</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|padding=5em}}</syntaxhighlight> | * <translate><!--T:71--> Adding extra padding</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|padding=5em}}</syntaxhighlight> | ||
{{Collapse top|padding=5em}} | {{Collapse top|padding=5em}} | ||
| Line 136: | Line 139: | ||
{{Collapse bottom}} | {{Collapse bottom}} | ||
* <translate>Archiving a section</translate> – <translate>The markup below:</translate> | * <translate><!--T:72--> Archiving a section</translate> – <translate><!--T:73--> The markup below:</translate> | ||
<syntaxhighlight lang="html5">{{Collapse top}} | <syntaxhighlight lang="html5">{{Collapse top}} | ||
| Line 144: | Line 147: | ||
<translate> | <translate> | ||
<!--T:74--> | |||
must be rewritten as: | must be rewritten as: | ||
</translate> | </translate> | ||
| Line 152: | Line 156: | ||
<translate> | <translate> | ||
<!--T:75--> | |||
The end result: | The end result: | ||
</translate> | </translate> | ||
| Line 160: | Line 165: | ||
<translate> | <translate> | ||
== TemplateData == | == TemplateData == <!--T:76--> | ||
</translate> | </translate> | ||
{{Collapse top/doc}} | {{Collapse top/doc}} | ||
Revision as of 07:00, 1 November 2020
<languages />
| Extended content |
|---|
|
<translate> The following content has been placed in a collapsed box for improved usability.</translate>
|
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:}}]]