Template:Collapse top/doc: Difference between revisions
Jump to navigation
Jump to search
Optimised Text
w:en>MC10 (fix parameter) |
w:en>Thesevenseas (Optimised Text) |
||
| Line 3: | Line 3: | ||
{{shortcut|Template:Cot|Template:Cob}} | {{shortcut|Template:Cot|Template:Cob}} | ||
The Collapse template is used for placing collapse boxes around discussions. | The Collapse template is used for placing collapse boxes around discussions. It is a two-part template, used in conjunction with {{#switch: {{BASEPAGENAME}} | Collapse top={{tl|Collapse bottom}} ({{tl|cob}}) | Collapse bottom={{tl|Collapse top}} ({{tl|cot}}) | #default=its paired template }}. | ||
This template should only be used in accordance with the [[Wikipedia:refactoring]] guideline; it should never be used to to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing. | This template should only be used in accordance with the [[Wikipedia:refactoring]] guideline; it should never be used to to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing. | ||
== Usage == | == Usage == | ||
Place {{tl| | |||
Place {{#ifeq: {{BASEPAGENAME}} | Collapse top | this template | {{tl|collapse top}} }} and {{#ifeq: {{BASEPAGENAME}} | Collapse bottom | this template | {{tl|collapse bottom}} }} around the text to be collapsed. For example: | |||
<pre>{{Collapse top|This is the title text}} | <pre>{{Collapse top|This is the title text}} | ||
| Line 21: | Line 22: | ||
This template takes the following parameters, all of which are optional | This template takes the following parameters, all of which are optional | ||
;''positional parameter 1'', named parameter 'title': These parameters give the main title of collapsed box, which occurs on the same line as the ''show'' link and is always visible. | ;''positional parameter 1'', named parameter 'title': These parameters give the main title of collapsed box, which occurs on the same line as the ''show'' link and is always visible. It defaults to 'Extended content'. | ||
;warning: If this parameter evaluates to true (i.e. is not 0, false, or empty) it will display a default warning line under the main title which reads 'The following is an archived debate. <span style="color:red;">'''Please do not modify it.'''</span>' | ;warning: If this parameter evaluates to true (i.e. is not 0, false, or empty) it will display a default warning line under the main title which reads 'The following is an archived debate. <span style="color:red;">'''Please do not modify it.'''</span>' | ||
;''positional parameter 2'': This is optional warning-line text. | ;''positional parameter 2'': This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter. | ||
;'expand': If this parameter evaluates to true (i.e. is not 0, false, or empty) it will leave the material uncollapsed with the border and coloring. | ;'expand': If this parameter evaluates to true (i.e. is not 0, false, or empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material. | ||
;'bg': Sets the background color of the collapsed material. | ;'bg': Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. | ||
;'border': Sets the width of the border line on the collapsed material. | ;'border': Sets the width of the border line on the collapsed material. defaults to 1px. | ||
;'b-color': Sets the border color. defaults to silver. | ;'b-color': Sets the border color. defaults to silver. | ||
;'padding': Sets the padding on the collapsed material in the colored area. | ;'padding': Sets the padding on the collapsed material in the colored area. defaults to 8 px | ||
;'width': Sets the width of the overall template | ;'width': Sets the width of the overall template | ||
;'border2': Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line) | ;'border2': Sets the border of the box that appears when template is expanded; defaults to "1px silver" (no provision to change from a solid line) | ||
| Line 68: | Line 69: | ||
== Redirects == | == Redirects == | ||
* {{Tl|DAT}} | * {{Tl|DAT}} | ||
* {{tl|hidden archive top}} | * {{tl|hidden archive top}} | ||
* {{tl|hidden archive bottom}} | |||
== See also == | == See also == | ||
* {{ | |||
* {{ | * {{tl|collapse}} | ||
* {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }} | |||
* {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }} | |||
* {{tl|discussion top}} | * {{tl|discussion top}} | ||
* {{tl|archive top}} | * {{tl|archive top}} | ||