Template:Collapse top/doc: Difference between revisions

From Skulepedia
Jump to navigation Jump to search
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. It is a two-part template, used in conjunction with {{tl|Collapse bottom}} ({{tl|cob}}).
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|Collapse top}} and {{tl|Collapse bottom}} around the text to be collapsed. example:
 
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. It defaults to 'Extended content'.
;''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. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.
;''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. Default is to collapse the material.
;'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. Defaults to #CFC - a pleasant green.
;'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. defaults to 1px.
;'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. defaults to 8 px
;'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 bottom}}
 
* {{Tl|collapse}}
* {{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}}

Revision as of 15:59, 1 August 2010

{{#invoke:Message box|ombox}} Template:Shortcut

The Collapse template is used for placing collapse boxes around discussions. It is a two-part template, used in conjunction with {{Collapse bottom}} ({{cob}}).

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

Place this template and {{collapse bottom}} around the text to be collapsed. For example: 

{{Collapse top|This is the title text}}
{{lorem ipsum}}
{{Collapse bottom}}

produces

This is the title text

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Parameters

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. 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. Please do not modify it.'
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. Default is to collapse the 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. defaults to 1px.
'b-color'
Sets the border color. defaults to silver.
'padding'
Sets the padding on the collapsed material in the colored area. defaults to 8 px
'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)
'bg2'
Sets background of the box that appears when template is expanded; defaults to white.

If an entire section is being archived, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC.

Examples

  • changing background color - {{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • adding extra padding - {{cot|padding=40px}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • adding a warning line - {{cot|default warning|warning=1}}, {{cot|custom warning|this is a custom warning line}}

Template:Cot Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob Template:Cot Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Template:Cob

  • archiving a section
{{cot}}
==section header==
text
{{cob}}

rewritten as 

{{cot|section header}}
text
{{cob}}

Template:Cot text Template:Cob

General information

Redirects

See also


Retrieved from "https://skulepedia.ca/w/index.php?title=Template:Collapse_top/doc&oldid=6517"