Difference between revisions of "Template:Collapse top"

From WPRDC Wiki
Jump to navigation Jump to search
>Pppery
(Add documentation (derived from en:Template:Collapse top/doc, with TemplateData from en:Template:Collapse top/TemplateData), thereby fulfilling the "please document this better" request)
>Baris6161TURK
(It has quote on it.)
 
(19 intermediate revisions by 5 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
<languages />
<languages/>
</noinclude>{{#switch:<translate></translate>
</noinclude><!--
| =
--><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="mw-collapsible {{#if:{{{expand|}}}|| mw-collapsed}}" style="margin-top:.2em; border:{{{border|1px}}} solid {{{b-color|silver}}};text-align:{{dir|{{pagelang}}|right|left}}; width: {{{width|100%}}};"><tr><th style="font-size:112%;background:{{{bg|#F8FCFF}}};color:{{{fc|black}}};text-align:{{#if:{{{left|}}}
<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}}};}}">
  | {{dir|{{pagelang}}|right|left}}
<tr>
  | center
<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|<translate><!--T:1--> Extended content</translate>}}} }}} }}} }}} }}}
  }}">{{{1|{{{title|{{{reason|{{{header|{{{heading|<translate><!--T:1--> Extended content</translate>}}}}}}}}}}}}}}}</th></tr><!--
{{#if:{{{warning|{{{2|}}}}}}
  -->{{#if:{{{warning|{{{2|}}}}}}
|</th>
  | <tr><td style="text-align:center;font-style:italic">{{{2|<translate><!--T:2--> The following is a closed debate.</translate> {{Strong
  </tr><tr>
    | style = color:red
  <td style="text-align:center; font-style:italic">{{{2|<translate><!--T:2--> The following is a closed debate.</translate> {{strongbad|<translate><!--T:3--> Please do not modify it.</translate>}} }}}</td>
    | 1 = <translate><!--T:3--> Please do not modify it.</translate>
|</th>
    }}}}}</td></tr>
}}
  }}<!--
</tr><tr>
  --><tr><td style="font-size:112%;background:{{{bg2|white}}};border:solid {{{border2|1px silver}}};padding:{{{padding|8px}}}"><!--
<td style="border:solid {{{border2|1px silver}}}; padding:{{{padding|8px}}}; background-color:{{{bg2|white}}}; font-size:112%">
--><noinclude>
| #default=
<div style="width:100%;text-align:center">''<translate><!--T:4--> The following content has been placed in a collapsed box for improved usability.</translate>''</div>
  {{#invoke:Template translation|renderTranslatedTemplate|template=Template:Collapse top|noshift=1}}
}}<noinclude>
<div style="width:100%; text-align:center">''<translate><!--T:4--> The following content has been placed in a collapsed box for improved usability.</translate>''</div>
{{Collapse bottom}}
{{Collapse bottom}}
{{Documentation|content=
{{Documentation|content=
<translate>
<!--T:12-->
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.


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 == <!--T:8-->
</translate>
<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>
<translate><!--T:14--> For example:</translate>


== Usage ==
<syntaxhighlight lang="html5">
Place {{tlx|collapse top}} and {{tlx|collapse bottom}} around the text to be collapsed. For example:
{{Collapse top|title=This is the title text}}
Sample contents text
{{Collapse bottom}}
</syntaxhighlight>


<pre>{{collapse top|title=This is the title text}}
<translate>
Sample contents text
<!--T:15-->
{{collapse bottom}}</pre>
produces:
produces:
{{collapse top|title=This is the title text}}
</translate>
 
{{Collapse top|title=This is the title text}}
Sample contents text
Sample contents text
{{collapse bottom}}
{{Collapse bottom}}
 
<translate>
<!--T:16-->
<tvar name=1>{{Tlx|Collapse bottom}}</tvar> should always be placed on its own line.
 
== Parameters == <!--T:9-->
</translate>
<translate><!--T:17--> This template takes the following parameters, all of which are optional.</translate>
<translate><!--T:18--> They are case-sensitive.</translate>
<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>
 
; {{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><!--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><!--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>
; {{Para|warning|yes}}
: <translate><!--T:25--> 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><!--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>
; {{Para|2}} <span style="font-weight:normal"><translate><!--T:28--> (or second unnamed parameter)</translate></span>
: <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>
; {{Para|left|yes}}
: <translate><!--T:31--> Will align the title along the left margin (in RTL languages, along the right margin instead).</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><!--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>
; {{Para|expand|yes}}
: <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><!--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>
; {{Para|bg}}
: <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>
; {{Para|fc}}
: <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>
; {{Para|border}}
: <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>
; {{Para|b-color}}
: <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>
; {{Para|padding}}
: <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>
; {{Para|width}}
: <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>
; {{Para|border2}}
: <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>
; {{Para|bg2}}
: <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>
; {{Para|indent}}
: <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>
 
<translate>
== Examples == <!--T:10-->
</translate>
* <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}}
{{Lorem ipsum}}
{{Collapse bottom}}
 
* <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}}
{{Lorem ipsum}}
{{Collapse bottom}}


{{tlx|collapse bottom}} should always be placed on its own line.
* <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>


== Parameters ==
{{Collapse top|This is the title text|This is a custom warning line}}
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>.
{{Lorem ipsum}}
{{Collapse bottom}}


;{{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.
* <translate><!--T:69--> Aligning box title along left margin</translate> – <syntaxhighlight lang="html5" inline>{{Collapse top|left=true}}</syntaxhighlight>
;{{para|warning|yes}}: Will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}" 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).
;{{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}}: 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|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).
;{{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>).
;{{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}}: 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}}: Sets the border color. defaults to <code>silver</code> (<code>#C0C0C0</code>). See {{para|bg}}, above, for details on color options.
;{{para|padding}}: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>8px</code>.
;{{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.).
;{{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}}: 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|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).


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


== TemplateData ==
<translate>
{{TemplateData header}}
== TemplateData == <!--T:76-->
<templatedata>
</translate>
{
{{Collapse top/doc}}
"params": {
"1": {
"aliases": [
"title",
"heading",
"header",
"reason",
"result"
],
"label": "Title",
"description": "Main title of collapsed box",
"example": "This is the title text",
"required": true
},
"2": {
"label": "Custom warning line",
"description": "Will override the standard warning line, and make the 'warning' parameter unnecessary",
"example": "This is a custom warning line",
"type": "string"
},
"indent": {
"description": "Indents the box from the left of the page",
"type": "unknown",
"autovalue": "0px"
},
"expand": {
"aliases": [
"collapse"
], "description": "Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring",
"example": "true",
"type": "string",
"autovalue": ""
},
"border": {
"label": "Border width (px)",
"description": "Sets the width of the border line on the collapsed material",
"example": "2px",
"default": "1px",
"autovalue": ""
},
"b-color": {
"label": "Border color",
"description": "Sets the border color",
"example": "#F0F2F5",
"default": "Silver"
},
"width": {
"label": "Template width (px or %)",
"description": "Sets the width of the overall template",
"example": "50%"
},
"bg": {
"label": "Collapsed material background color",
"description": "Sets the background color of the collapsed material",
"example": "#F0F2F5",
"default": "#CFC"
},
"left": {
"label": "Alight along the left margin (true or blank)",
"description": "Will align the 'parameter 1 title' along the left margin",
"example": "true",
"type": "string"
},
"fc": {
"label": "Title font color",
"description": "Sets the font color of the title of the collapsible bar",
"example": "#F0F2F5",
"default": "Black"
},
"warning": {
"label": "Warning (true or blank)",
"description": "Will display a default warning line under the main title which reads \"The following is a closed debate. Please do not modify it.\"",
"example": "true"
},
"border2": {
"label": "Expanded box border size & color",
"description": "Sets the border of the box that appears when template is expanded",
"example": "2px",
"default": "1px silver"
},
"padding": {
"label": "Padding (px)",
"description": "Sets the padding on the collapsed material in the colored area",
"example": "16px",
"default": "8px"
},
"bg2": {
"label": "Expanded box color",
"description": "Sets background of the box that appears when template is expanded",
"example": "#F0F2F5",
"default": "white"
}
},
"description": "Use in conjunction with {{Collapse bottom}}. Will collapse text in between the two templates."
}
</templatedata>


== See also ==
<translate>
* {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }}
== See also == <!--T:11-->
* {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }}
</translate>
* {{tl|discussion top}} and {{tl|discussion 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:Collapse templates]]
[[Category:Formatting templates{{#translation:}}]]
[[Category:Formatting templates{{#translation:}}]]
}}
}}
</noinclude>
</noinclude>

Latest revision as of 10:28, 12 October 2021

<languages/>

<translate> Extended content</translate>
<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:}}]]

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