Difference between revisions of "Template:Collapse top/en"

From WPRDC Wiki
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 1: Line 1:
<noinclude>
<noinclude><languages />
<languages />
</noinclude>{{#switch:  
</noinclude>{{#switch:
| = <!--
| =
--><div style="display:{{{display|block}}};margin-{{dir|{{pagelang}}|right|left}}:{{{indent|0}}};{{{extrastyle|}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section
<div style="display:{{{display|block}}}; margin-{{dir|{{pagelang}}|right|left}}:{{{indent|0px}}}; {{{extrastyle|}}}"><!-- NOTE: width renders incorrectly if added to main STYLE section-->
  --><table class="navbox mw-collapsible {{#if:{{{expand|}}}
<table class="navbox mw-collapsible {{#if:{{{expand|}}}||mw-collapsed}}" style="background:{{{bg1|transparent}}}; text-align:{{dir|{{pagelang}}|right|left}}; border:{{{border|1px}}} solid {{{b-color|silver}}}; margin-top:0.2em; {{#if:{{{width|}}}|width:{{{width}}};}}">
  || mw-collapsed
<tr>
  }}" style="margin-top:.2em;background:{{{bg1|transparent}}};border:{{{border|1px}}} solid {{{b-color|silver}}};text-align:{{dir|{{pagelang}}|right|left}};{{#if:{{{width|}}}
<th style="background-color:{{{bg|#F8FCFF}}}; text-align:{{#if:{{{left|}}}|{{dir|{{pagelang}}|right|left}}|center}}; font-size:112%; color:{{{fc|black}}}">{{{1|{{{title|{{{reason|{{{header|{{{heading|Extended content}}} }}} }}} }}} }}}
  | width:{{{width}}}
{{#if:{{{warning|{{{2|}}}}}}
  }}"><tr><th style="font-size:112%;background:{{{bg|#F8FCFF}}};color:{{{fc|black}}};text-align:{{#if:{{{left|}}}
|</th>
  | {{dir|{{pagelang}}|right|left}}
  </tr><tr>
  | center
  <td style="text-align:center; font-style:italic">{{{2|The following is a closed debate. {{strong|1=Please do not modify it.}}|style=color:red}}}</td>
  }}">{{{1|{{{title|{{{reason|{{{header|{{{heading|Extended content}}}}}}}}}}}}}}}</th></tr><!--
|</th>
  -->{{#if:{{{warning|{{{2|}}}}}}
}}
  | <tr><td style="text-align:center;font-style:italic">{{{2|The following is a closed debate. {{Strong
</tr><tr>
    | style = color:red
<td style="border:solid {{{border2|1px silver}}}; padding:{{{padding|8px}}}; background-color:{{{bg2|white}}}; font-size:112%">
    | 1 = Please do not modify it.
| #default=
    }}}}}</td></tr>
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Collapse top|noshift=1}}
  }}<!--
  --><tr><td style="font-size:112%;background:{{{bg2|white}}};border:solid {{{border2|1px silver}}};padding:{{{padding|8px}}}">
|#default =<!--
-->{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Collapse top|noshift=1}}
}}<noinclude>
}}<noinclude>
<div style="width:100%; text-align:center">''The following content has been placed in a collapsed box for improved usability.''</div>
<div style="width:100%;text-align:center">''The following content has been placed in a collapsed box for improved usability.''</div>
{{Collapse bottom}}
{{Collapse bottom}}
{{Documentation|content=
{{Documentation|content=
 
<div lang="en" dir="ltr" class="mw-content-ltr">
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.
</div>


== Usage ==
== Usage ==
Place {{tlx|collapse top}} and {{tlx|collapse bottom}} around the text to be collapsed. For example:
<span lang="en" dir="ltr" class="mw-content-ltr">Place {{Tlx|Collapse top}} and {{Tlx|Collapse bottom}} around the text to be collapsed.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">For example:</span>


<pre>{{collapse top|title=This is the title text}}
<syntaxhighlight lang="html5">
{{Collapse top|title=This is the title text}}
Sample contents text
Sample contents text
{{collapse bottom}}</pre>
{{Collapse bottom}}
</syntaxhighlight>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
produces:
produces:
{{collapse top|title=This is the title text}}
</div>
 
{{Collapse top|title=This is the title text}}
Sample contents text
Sample contents text
{{collapse bottom}}
{{Collapse bottom}}


{{tlx|collapse bottom}} should always be placed on its own line.
<div lang="en" dir="ltr" class="mw-content-ltr">
{{Tlx|Collapse bottom}} should always be placed on its own line.
</div>


== 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&nbsp;em</code>.
<span lang="en" dir="ltr" class="mw-content-ltr">This template takes the following parameters, all of which are optional.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">They are case-sensitive.</span>
<span lang="en" dir="ltr" class="mw-content-ltr">Those that take CSS measurements require them in CSS format (e.g. <code style="color: #006400">1em</code> not <code style="color:#8B0000">1&nbsp;em</code>.</span>


;{{para|1}}, {{para|title}}, {{para|reason}}, {{para|header}}, {{para|heading}} <span style="font-weight: normal;">, or first unnamed parameter</span>: 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|1}} <span style="font-weight:normal"><span lang="en" dir="ltr" class="mw-content-ltr">(or first unnamed parameter)</span></span>, {{Para|title}}, {{Para|reason}}, {{Para|header}}, {{Para|heading}}
;{{para|warning|yes}}: Will display a default warning line under the main title which reads "The following is a closed debate. {{strong|Please do not modify it.|style="color:red"}}" Any value supplied to this parameter will have this effect (i.e. {{para|warning|<span style="color:#8B0000">no</span>}} will not work as expected).
: <span lang="en" dir="ltr" class="mw-content-ltr">Will give the collapsed box a title, which occurs on the same line as the ''show'' link and is always visible.</span> <span lang="en" dir="ltr" class="mw-content-ltr">It defaults to "Extended content".</span>
;{{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.
: <span lang="en" dir="ltr" class="mw-content-ltr">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>.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Note: The shorter, unnamed markup will not work if the title value contain an equals (<code>=</code>) character.</span>
;{{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 value will enable this parameter (i.e. {{para|left|<span style="color:#8B0000">no</span>}} will not work as expected)
; {{Para|warning|yes}}
;{{para|expand|yes}}: Will leave the material uncollapsed with the border and coloring. Default is to collapse the material. Any value will have this effect (i.e. {{para|expand|<span style="color:#8B0000">no</span>}} will not work as expected).
: <span lang="en" dir="ltr" class="mw-content-ltr">Will display a default warning line under the main title which reads "The following is a closed debate.</span> <span lang="en" dir="ltr" class="mw-content-ltr">{{Strong|style=color:red|Please do not modify it.}}"</span>
;{{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> (HTML color codes require the leading <code>#</code>).
: <span lang="en" dir="ltr" class="mw-content-ltr">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).</span>
;{{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|2}} <span style="font-weight:normal"><span lang="en" dir="ltr" class="mw-content-ltr">(or second unnamed parameter)</span></span>
;{{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.
: <span lang="en" dir="ltr" class="mw-content-ltr">This is optional warning-line text.</span> <span lang="en" dir="ltr" class="mw-content-ltr">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.</span>
;{{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|left|yes}}
;{{para|padding}}: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>8px</code>.
: <span lang="en" dir="ltr" class="mw-content-ltr">Will align the title along the left margin (in RTL languages, along the right margin instead).</span>
;{{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 <samp>em</samp> 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.).
: <span lang="en" dir="ltr" class="mw-content-ltr">By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.</span>
;{{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.
: <span lang="en" dir="ltr" class="mw-content-ltr">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).</span>
;{{para|bg2}}: Sets the background color of the box that appears when template is expanded; defaults to <code>White</code> (<code>#FFFFFF</code>). See {{para|bg}}, above, for details on color options.
; {{Para|expand|yes}}
;{{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 why).
: <span lang="en" dir="ltr" class="mw-content-ltr">Will leave the material uncollapsed with the border and coloring.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Default is to collapse the material.</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">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).</span>
; {{Para|bg}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the background color of the title of the collapsible bar.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to "#F8FCFF", a whitish color.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Named colors are listed at [[List of colors]].</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">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>).</span>
; {{Para|fc}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the font color of the title of the collapsible bar.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to "black".</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">See {{Para|bg}}, above, for details on color options.</span>
; {{Para|border}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the width of the border line on the collapsed material.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to <code>1px</code>.</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">For example, <code><nowiki>{{Collapse top|border=2px}}</nowiki></code>; going much thicker than this is not very useful.</span>
; {{Para|b-color}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the border color.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to <code>silver</code> (<code>#C0C0C0</code>).</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">See {{Para|bg}}, above, for details on color options.</span>
; {{Para|padding}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the padding (distance from borders) on the collapsed material inside the colored area.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to <code>8px</code>.</span>
; {{Para|width}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the width of the overall template relative to the page (or a block element containing the collapse box).</span> <span lang="en" dir="ltr" class="mw-content-ltr">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}}.</span> <span lang="en" dir="ltr" class="mw-content-ltr">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.).</span>
; {{Para|border2}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the properties of the border of the box that appears when template is expanded.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to <code>1px silver</code> (there is no provision to change from a solid line).</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">For example, <code><nowiki>{{Collapse top|border2=2px}}</nowiki></code> (only width or color will be changed if only one value is supplied).</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">See {{Para|bg}}, above, for details on color options.</span>
; {{Para|bg2}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Sets the background color of the box that appears when template is expanded; defaults to <code>white</code> (<code>#FFF</code>).</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">See {{Para|bg}}, above, for details on color options.</span>
; {{Para|indent}}
: <span lang="en" dir="ltr" class="mw-content-ltr">Indents the box from the left of the page.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Defaults to no indentation.</span> <span lang="en" dir="ltr" class="mw-content-ltr">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}}.</span> <span lang="en" dir="ltr" class="mw-content-ltr">You can also use a percentage value.</span>
: <span lang="en" dir="ltr" class="mw-content-ltr">Pixel-based values should be avoided (see {{Para|width}}, above, for the reason).</span>


== Examples ==
== Examples ==
* Adding a box title (if omitted, default is 'Extended content') – <code><nowiki>{{collapse top|This is the title text}}</nowiki></code>
* <span lang="en" dir="ltr" class="mw-content-ltr">Adding a box title (if omitted, default is "Extended content")</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text}}</syntaxhighlight>
{{collapse top|This is the title text}}
 
{{lorem ipsum}}
{{Collapse top|This is the title text}}
{{collapse bottom}}
{{Lorem ipsum}}
* Adding a standard warning line – <code><nowiki>{{collapse top|This is the title text|warning=true}}</nowiki></code>
{{Collapse bottom}}
{{collapse top|This is the title text|warning=true}}
 
{{lorem ipsum}}
* <span lang="en" dir="ltr" class="mw-content-ltr">Adding a standard warning line</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|warning=true}}</syntaxhighlight>
{{collapse bottom}}
 
* Adding a custom warning line – <code><nowiki>{{collapse top|This is the title text|This is a custom warning line}}</nowiki></code>
{{Collapse top|This is the title text|warning=true}}
{{collapse top|This is the title text|This is a custom warning line}}
{{Lorem ipsum}}
{{lorem ipsum}}
{{Collapse bottom}}
{{collapse bottom}}
 
* Aligning box title along left margin – <code><nowiki>{{collapse top|left=true}}</nowiki><!-- or {{collapse top|left=true}}--><nowiki></nowiki></code>
* <span lang="en" dir="ltr" class="mw-content-ltr">Adding a custom warning line</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|This is the title text|This is a custom warning line}}</syntaxhighlight>
{{collapse top|left=true}}
 
{{lorem ipsum}}
{{Collapse top|This is the title text|This is a custom warning line}}
{{collapse bottom}}
{{Lorem ipsum}}
* Changing background color – <code><nowiki>{{collapse top|bg=#F0F2F5}}</nowiki></code>
{{Collapse bottom}}
{{collapse top|bg=#F0F2F5}}
 
{{lorem ipsum}}
* <span lang="en" dir="ltr" class="mw-content-ltr">Aligning box title along left margin</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight>
{{collapse bottom}}
 
* Adding extra padding – <code><nowiki>{{collapse top|padding=5em}}</nowiki></code>
{{Collapse top|left=true}}
{{collapse top|padding=5em}}
{{Lorem ipsum}}
{{lorem ipsum}}
{{Collapse bottom}}
{{collapse bottom}}
 
* Archiving a section: the markup below:
* <span lang="en" dir="ltr" class="mw-content-ltr">Changing background color</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|bg=#F0F2F5}}</syntaxhighlight>
<pre>{{collapse top}}
 
==Section header==
{{Collapse top|bg=#F0F2F5}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <span lang="en" dir="ltr" class="mw-content-ltr">Adding extra padding</span> – <syntaxhighlight lang="html5" inline>{{Collapse top|padding=5em}}</syntaxhighlight>
 
{{Collapse top|padding=5em}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <span lang="en" dir="ltr" class="mw-content-ltr">Archiving a section</span> – <span lang="en" dir="ltr" class="mw-content-ltr">The markup below:</span>
 
<syntaxhighlight lang="html5">{{Collapse top}}
== Section header ==
Sample contents text
Sample contents text
{{collapse bottom}}</pre>
{{Collapse bottom}}</syntaxhighlight>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
must be rewritten as:
must be rewritten as:
<pre>{{collapse top|Section header}}
</div>
 
<syntaxhighlight lang="html5">{{Collapse top|Section header}}
Sample contents text
Sample contents text
{{collapse bottom}}</pre>
{{Collapse bottom}}</syntaxhighlight>
 
<div lang="en" dir="ltr" class="mw-content-ltr">
The end result:
The end result:
{{collapse top|Section header}}
</div>
 
{{Collapse top|Section header}}
Sample contents text
Sample contents text
{{collapse bottom}}
{{Collapse bottom}}


<div lang="en" dir="ltr" class="mw-content-ltr">
== TemplateData ==
== TemplateData ==
</div>
{{Collapse top/doc}}
{{Collapse top/doc}}


== See also ==
== See also ==
* {{tl|collapse bottom}}
* {{Tl|Collapse bottom}}
* {{tl|hidden archive top}} and {{tl|hidden archive bottom}}
* {{Tl|Hidden archive top}} and {{Tl|Hidden archive bottom}}
* {{tl|hidden begin}} and {{tl|hidden end}}
* {{Tl|Hidden begin}} and {{Tl|Hidden end}}
* {{tl|hidden}}}
* {{Tl|Hidden}}}


[[Category:Formatting templates{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}]]
}}
}}
</noinclude>
</noinclude>

Revision as of 07:00, 1 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:}}]]

Retrieved from "https://wiki.tessercat.net/index.php?title=Template:Collapse_top/en&oldid=10875"