Template:Collapse top/doc
{{#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
Redirects
To Collapse top:
To Collapse bottom:
- {{cob}}
- {{hab}}
- {{hidden archive bottom}}
See also
- {{collapse}}
- {{collapse bottom}}
- {{discussion top}}
{{#invoke:Navbox|navbox}}