Template:Collapse top

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search
Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Documentation icon Documentationviewedithistorypurge

This documentation is transcluded from Template:Collapse top/doc.

The collapse template is used for placing collapse boxes around discussions.

Usage

{{Collapse top}}

Place {{collapse top}} and {{collapse bottom}} around the text to be collapsed. 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.

Template parameters

ParameterDescriptionDefaultStatus
1
title
reason
header
heading
headerThese parameters give the main title of collapsed box, which occurs on the same line as the show link and is always visible.Extended contentoptional
warning
show warning textIf 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.' (except if parameter #2 is given).emptyoptional
2
custom warning textThis is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.emptyoptional
expand
expandIf 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. However, when previewing edits, content will always display as uncollapsed; this is often helpful, but also often confusing!emptyoptional
bg
backgroundSets the background color of the collapsed material#CFC - a pleasant greenoptional
border
border widthSets the width of the border line on the collapsed material.1pxoptional
b-color
border colorSets the border color.silveroptional
padding
paddingSets the padding on the collapsed material in the colored area.8pxoptional
width
box widthSets the width of the overall templateemptyoptional
Template data
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either useTemplateData=1 or useTemplateData=only on the /doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

The collapse template is used for placing collapse boxes around discussions.

Template parameters

ParameterDescriptionTypeStatus
header1title reason header heading

These parameters give the main title of collapsed box, which occurs on the same line as the ''show'' link and is always visible.

Default
Extended content
Stringoptional
custom warning text2

This is optional warning-line text. It will override the standard warning line above, and obviate the need for setting the 'warning' parameter.

Lineoptional
border colorb-color

Sets the border color.

Default
silver
Stringoptional
backgroundbg

Sets the background color of the collapsed material

Default
#CFC - a pleasant green
Stringoptional
border widthborder

Sets the width of the border line on the collapsed material.

Default
1px
Numberoptional
expandexpand

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. However, when previewing edits, content will always display as uncollapsed; this is often helpful, but also often confusing!

Unknownoptional
paddingpadding

Sets the padding on the collapsed material in the colored area.

Default
8px
Numberoptional
show warning textwarning

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.', where the second sentence is in bold and red (except if parameter #2 is given).

Unknownoptional
box widthwidth

Sets the width of the overall template

Numberoptional

Additional information

The template is intended to be used in the following namespaces: all talk namespaces and noticeboards

The template is intended to be used by the following user groups: no user group specified

See also

Localization

This template is not intended to be localized.

Examples

Simple

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

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Changing background color

{{Collapse top|bg=#F0F2F5}} or {{cot|bg=#F0F2F5}}
Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Changing border color

{{cot|b-color=#ff0000}}
Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Adding extra padding

{{cot|padding=40px}}
Extended content

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Adding a warning line

{{cot|default warning|warning=1}}
default warning
The following is a closed debate. Please do not modify it.

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

{{cot|custom warning|this is a custom warning line}}
custom warning
this is a custom warning line

Lorem ipsum dolor sit amet, consectetur adipisicing 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.

Archiving a section

{{cot}}
==section header==
text
{{cob}}

rewritten as

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

text

Template:Collapse top/TemplateData