Template:Collapse top/doc: Difference between revisions

Latest revision as of 01:00, 3 September 2020

This is a documentation subpage for Template:Collapse top.
It may contain usage information, categories and other content that is not part of the original template page.

This template is used on approximately 44,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

This template is used in MediaWiki:Protect-text.
Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please discuss any changes on the talk page before implementing them.

Shortcuts

{{Cot}}
{{Cob}}

The {{collapse top}} template (or {{cot}}), and its paired template {{collapse bottom}} (or {{cob}}), are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables. For very simple content, the one-piece template {{collapse}} can be used instead.

These templates should only be used in accordance with the Wikipedia:Refactoring guideline; they should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Do not hide content in articles. This violates the Wikipedia:Manual of Style § Scrolling lists and collapsible content and Wikipedia:Accessibility guidelines.

Usage

Place {{collapse top}} (or {{cot}}), and {{collapse bottom}} (or {{cob}}), around the text to be collapsed. For example:

{{collapse top|title=This is the title text}}
Sample contents text
{{collapse bottom}}

produces:

This is the title text
Sample contents text

{{collapse bottom}} should always be placed on its own line.

Parameters

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. 1em not 1 em.

|1=, |title=, |reason=, |header=, |heading=, |result=, or first unnamed parameter: 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, {{collapse top|title=This is the title text}} or {{collapse top|This is the title text}}. Note: The shorter, unnamed markup will not work if the title value contain an equals (=) character.
|warning=yes: Will display a default warning line under the main title which reads "The following is a closed debate. Please do not modify it." Any value supplied to this parameter will have this effect (i.e. |warning=no will not work as expected).
|2= or second unnamed parameter: This is optional warning-line text. It will override the standard warning line above; it is not necessary to also use |warning=yes in this case, though doing so is harmless.
|left=yes: Will align the title along the left margin. 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. |left=no will not work as expected); nor is there a |right= parameter (only useful in a right-to-left language).
|expand=yes or |collapse=no: Will leave the material uncollapsed with the border and coloring. Default is to collapse the material. Any value will have this effect (i.e. |expand=no and |collapse=yes will not work as expected).
|bg=: Sets the background color of the collapsed material. Defaults to #CCFFCC, a green hue. Named colors are listed at List of colors. For example, {{collapse top|This is the title text|bg=#F0F2F5}} or {{collapse top|This is the title text|bg=LightGrey}} (HTML color codes require the leading #).
|fc=: Sets the font color of the title of the collapsible bar. Defaults to inheriting the current text color of the context. See |bg=, above, for details on color options.
|border=: Sets the width of the border line on the collapsed material. defaults to 1px. For example, {{collapse top|border=2px}}; going much thicker than this is not very useful.
|b-color=: Sets the border color. defaults to Silver (#C0C0C0). See |bg=, above, for details on color options.
|padding=: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to 0.6em.
|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. |width=50%, or in relative em units, e.g. |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.).
|border2=: Sets the properties of the border of the box that appears when template is expanded; defaults to 1px Silver (there is no provision to change from a solid line). For example, {{collapse top|border2=2px}} (only width or color will be changed if only one value is supplied). See |bg=, above, for details on color options.
|bg2=: Sets the background color of the box that appears when template is expanded; defaults to White (#FFFFFF). See |bg=, above, for details on color options.
|indent=: Indents the box from the left of the page. Defaults to no indentation. Each : in talk page markup is approximately equivalent to 1.6em of indent (e.g., to match :::: indentation level, use |indent=6.4em. You can also use a percentage value. Pixel-based values should be avoided (see |width=, above, for why).
|clear=: In some situations you may not want the default clear: both; CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use |clear=none, |clear=right, or |clear=left, as needed.

Examples

Adding a box title (if omitted, default is 'Extended content') – {{collapse top|This is the title text}}

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.

Adding a standard warning line – {{collapse top|This is the title text|warning=true}}

This is the title text

The following is a closed discussion. Please do not modify it.

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.

Adding a custom warning line – {{collapse top|This is the title text|This is a custom warning line}}

This is the title text

This is a custom warning line

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.

Aligning box title along left margin – {{collapse top|left=true}}

Extended content

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.

Changing background color – {{collapse top|bg=#F0F2F5}}

Extended content

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.

Adding extra padding – {{collapse top|padding=5em}}

Extended content

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.

Archiving a section: the markup below:

{{collapse top}}
==Section header==
Sample contents text
{{collapse bottom}}

must be rewritten as:

{{collapse top|Section header}}
Sample contents text
{{collapse bottom}}

The end result:

Section header
Sample contents text

TemplateData

Template:Collapse top/TemplateData

Redirects

To Collapse top:

{{cot}}
{{ctop}}
{{DAT}}

To Collapse bottom:

{{cob}}
{{cbot}}

@@ Line 1: / Line 1: @@
 {{Documentation subpage}}
-{{Warning|Any contents enclosed by this template will not appear in mobile view or in print.  For this reason, the use of this template within articles is discouraged.  If you wish to collapse content in an article, consider using {{tl|hidden begin}}, but be mindful of [[MOS:COLLAPSE]].}}
+<!-- Place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
-{{High-use|20,000+}}
+{{High-use| 37900 }}
 {{used in system|in [[MediaWiki:Protect-text]]}}
-<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
+{{Template shortcut|Cot|Cob}}
-{{Template shortcut|Cot|Cob|Cb}}
+{{Template:Collapse Templates}}
 The {{tlx|collapse top}} template (or {{tlx|cot}}), and its paired template {{tlx|collapse bottom}} (or {{tlx|cob}}), are used for placing a collapse box around a talk page discussion, especially when the content contains complex wikimarkup such as tables. For very simple content, the one-piece template {{tlx|collapse}} can be used instead.
 These templates should only be used in accordance with the [[Wikipedia:Refactoring]] guideline; they should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.
+Do not hide content in articles. This violates the {{Section link|Wikipedia:Manual of Style|Scrolling lists and collapsible content}} and [[Wikipedia:Accessibility]] guidelines.
+== Usage ==
+Place {{tlx|collapse top}} (or {{tlx|cot}}), and {{tlx|collapse bottom}} (or {{tlx|cob}}), around the text to be collapsed. For example:
+<pre>{{collapse top|title=This is the title text}}
+Sample contents text
+{{collapse bottom}}</pre>
+produces:
+{{collapse top|title=This is the title text}}
+Sample contents text
+{{collapse bottom}}
+{{tlx|collapse bottom}} should always be placed on its own line.
 == Parameters ==
-This template takes the following parameters, all of which are optional
+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>{{mxt|1em}}</code> not <code>{{!mxt|1&nbsp;em}}</code>.
-;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'. For example <code><nowiki>{{cot|This is the title text}}</nowiki></code> or <code><nowiki>{{cot|title=This is the title text}}</nowiki></code>
+;{{para|1}}, {{para|title}}, {{para|reason}}, {{para|header}}, {{para|heading}}, {{para|result}}<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.
-;warning: If this parameter evaluates to true (i.e. is not empty) it will display a default warning line under the main title which reads "The following is a closed debate. {{strongbad|Please do not modify it.}}" For example <code><nowiki>{{cot|This is the title text|warning=true}}</nowiki></code>
+;{{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|{{!mxt|no}}}} will not work as expected).
-;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. For example <code><nowiki>{{cot|This is the title text|This is a custom warning line}}</nowiki></code>
+;{{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.
-;left: If this parameter evaluates to true (i.e. is not empty) it will align the 'parameter 1 title' along the left margin. Text aligns centered between the left margin and the left bracket of the left ''show'' link by default. For example <code><nowiki>{{cot|This is the title text|left=true}}</nowiki></code>
+;{{para|left|yes}}: Will align the title along the left margin. 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|{{!mxt|no}}}} will not work as expected); nor is there a {{para|{{!mxt|right}}}} parameter (only useful in a right-to-left language).
-;expand: If this parameter evaluates to true (i.e. is not empty) it will leave the material uncollapsed with the border and coloring. Default is to collapse the material. For example <code><nowiki>{{cot|This is the title text|expand=true}}</nowiki></code>
+;{{para|expand|yes}} <span style="font-weight: normal;">or</span> {{para|collapse|no}}: 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|{{!mxt|no}}}} and {{para|collapse|{{!mxt|yes}}}} will not work as expected).
-;bg: Sets the background color of the collapsed material. Defaults to #000CFC - a pleasant green. Other colors available from [[List of colors]]. For example <code><nowiki>{{cot|This is the title text|bg=#F0F2F5}}</nowiki></code>
+;{{para|bg}}: Sets the background color of the collapsed material. Defaults to <code>#CCFFCC</code>, a green hue. Named colors are listed at [[List of colors]]. For example, <code><nowiki>{{collapse top|This is the title text|bg=#F0F2F5}}</nowiki></code> or <code><nowiki>{{collapse top|This is the title text|bg=LightGrey}}</nowiki></code> (HTML color codes require the leading <code>#</code>).
-;fc: Sets the font color of the title of the collapsible bar. Defaults to Black. Other colors available from [[List of colors]]. For example <code><nowiki>{{cot|This is the title text|fc=#F0F2F5}}</nowiki></code>
+;{{para|fc}}: Sets the font color of the title of the collapsible bar. Defaults to inheriting the current text color of the context. See {{para|bg}}, above, for details on color options.
-;border: Sets the width of the border line on the collapsed material. defaults to 1px. For example <code><nowiki>{{cot|This is the title text|border=2px}}</nowiki></code>
+;{{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.
-;b-color: Sets the border color. defaults to silver. For example <code><nowiki>{{cot|This is the title text|b-color=#F0F2F5}}</nowiki></code>
+;{{para|b-color}}: Sets the border color. defaults to <code>Silver</code> (<code>#C0C0C0</code>). See {{para|bg}}, above, for details on color options.
-;padding: Sets the padding on the collapsed material in the colored area. Defaults to 8px. For example <code><nowiki>{{cot|This is the title text|padding=16px}}</nowiki></code>
+;{{para|padding}}: Sets the padding (distance from borders) on the collapsed material inside the colored area. Defaults to <code>0.6em</code>.
-;width: Sets the width of the overall template. Use {{para|width|50%}}, not {{para|Width|50%}} as upper case "W" doesn't work. Or <code>|width=200px</code> (if you omit "px" it doesn't work).
+;{{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.).
-;border2: Sets the border of the box that appears when template is expanded; defaults to "1px silver" (there is no provision to change from a solid line). For example <code><nowiki>{{cot|This is the title text|border2=2px}}</nowiki></code>
+;{{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.
-;bg2: Sets background of the box that appears when template is expanded; defaults to white. For example <code><nowiki>{{cot|This is the title text|bg2=#F0F2F5}}</nowiki></code>
+;{{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.
-;indent: indents the box from the left of the page. Use: {{para|indent|50px}} not {{para|Indent|50px}} (upper case "I" doesn't work). Defaults to "do not indent" (i.e. 0px). Each ":" in wiki-markup is approximately equivalent to 25px indent.
+;{{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).
+;{{para|clear}}: In some situations you may not want the default <code>clear: both;</code> CSS to apply, which puts the collapse box below any left- or right-floated content within the same HTML block. In this case, you can use {{para|clear|none}}, {{para|clear|right}}, or {{para|clear|left}}, as needed.
-If an entire section is being closed, remove the section header and add it as the first parameter of the template. This keeps the section header from showing in the TOC. For example <code><nowiki>{{cot|Section header}}</nowiki></code>
+== Examples ==
+* Adding a box title (if omitted, default is 'Extended content') – <code><nowiki>{{collapse top|This is the title text}}</nowiki></code>
+{{collapse top|This is the title text}}
+{{lorem ipsum}}
+{{collapse bottom}}
+* 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}}
+{{lorem ipsum}}
+{{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}}
+{{lorem ipsum}}
+{{collapse bottom}}
+* Aligning box title along left margin – <code><nowiki>{{collapse top|left=true}}</nowiki><!-- or {{collapse top|left=true}}--><nowiki></nowiki></code>
+{{collapse top|left=true}}
+{{lorem ipsum}}
+{{collapse bottom}}
+* Changing background color – <code><nowiki>{{collapse top|bg=#F0F2F5}}</nowiki></code>
+{{collapse top|bg=#F0F2F5}}
+{{lorem ipsum}}
+{{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
+{{collapse bottom}}</pre>
+must be rewritten as:
+<pre>{{collapse top|Section header}}
+Sample contents text
+{{collapse bottom}}</pre>
+The end result:
+{{collapse top|Section header}}
+Sample contents text
+{{collapse bottom}}
+== TemplateData ==
+*[[Template:Collapse top/TemplateData]]
 == Redirects ==
 To Collapse top:
 * {{tl|cot}}
+* {{tl|ctop}}
 * {{tl|DAT}}
 To Collapse bottom:
 * {{tl|cob}}
-* {{tl|hab}}
+* {{tl|cbot}}
-* {{tl|hidden archive bottom}}
 == See also ==
@@ Line 43: / Line 100: @@
 * {{#ifeq: {{BASEPAGENAME}} | Collapse top || {{tl|collapse top}} }}
 * {{#ifeq: {{BASEPAGENAME}} | Collapse bottom || {{tl|collapse bottom}} }}
-* {{tl|discussion top}}
+* {{tl|discussion top}} and {{tl|discussion bottom}}
-* {{tl|hidden archive top}}
+* {{tl|hidden archive top}} and {{tl|hidden archive bottom}}
+* {{tl|hidden begin}} and {{tl|hidden end}}
+* {{tl|hidden}}
+* {{tl|collapsible list}}
 {{Warchivenav|state=uncollapsed}}
-<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
+<includeonly>{{Sandbox other||
-<!-- CATEGORIES HERE, THANKS -->
+<!-- Categories below this line, please; interwikis at Wikidata -->
-[[Category:Archival templates|{{PAGENAME}}]]
+[[Category:Archival templates]]
-[[Category:Collapse templates|{{PAGENAME}}]]
+[[Category:Collapse templates]]
 }}</includeonly>

Template:Collapse top/doc: Difference between revisions

Latest revision as of 01:00, 3 September 2020

Contents

Usage

Parameters

Examples

TemplateData

Redirects

See also

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

In other languages