Template:Collapse top/doc: Difference between revisions
meta>SMcCandlish guidelines note |
meta>GoingBatty m typo(s) fixed: For example → For example, (13) using AWB (11376) |
||
| Line 26: | Line 26: | ||
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'. For example <code><nowiki>{{cot|This is the title text}}</nowiki></code> or <code><nowiki>{{cot|title=This is the title text}}</nowiki></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> | ||
;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> | ;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> | ||
;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> | ;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> | ||
;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> | ;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> | ||
;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> | ;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> | ||
;bg: Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from [[List of colors]]. For example <code><nowiki>{{cot|This is the title text|bg=#F0F2F5}}</nowiki></code> | ;bg: Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from [[List of colors]]. For example, <code><nowiki>{{cot|This is the title text|bg=#F0F2F5}}</nowiki></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> | ;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> | ||
;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> | ;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> | ||
;b-color: Sets the border color. defaults to silver. For example <code><nowiki>{{cot|This is the title text|b-color=#F0F2F5}}</nowiki></code> | ;b-color: Sets the border color. defaults to silver. For example, <code><nowiki>{{cot|This is the title text|b-color=#F0F2F5}}</nowiki></code> | ||
;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> | ;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> | ||
;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). | ;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). | ||
;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> | ;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> | ||
;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> | ;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> | ||
;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. | ;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. | ||
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> | 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 == | == Examples == | ||
| Line 81: | Line 81: | ||
Sample contents text | Sample contents text | ||
{{cob}} | {{cob}} | ||
== Redirects == | == Redirects == | ||
To Collapse top: | To Collapse top: | ||
Revision as of 20:16, 5 September 2015
 | 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. |
 | 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 {{hidden begin}}, but be mindful of MOS:COLLAPSE. |
 | This template is used on 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. |
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 WP:Manual of Style#Scrolling lists and collapsible content and WP: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 |
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'. For example,
{{cot|This is the title text}}or{{cot|title=This is the title text}} - 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. Please do not modify it." For example,
{{cot|This is the title text|warning=true}} - 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,
{{cot|This is the title text|This is a custom warning line}} - 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,
{{cot|This is the title text|left=true}} - 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,
{{cot|This is the title text|expand=true}} - bg
- Sets the background color of the collapsed material. Defaults to #CFC - a pleasant green. Other colors available from List of colors. For example,
{{cot|This is the title text|bg=#F0F2F5}} - fc
- Sets the font color of the title of the collapsible bar. Defaults to Black. Other colors available from List of colors. For example,
{{cot|This is the title text|fc=#F0F2F5}} - border
- Sets the width of the border line on the collapsed material. defaults to 1px. For example,
{{cot|This is the title text|border=2px}} - b-color
- Sets the border color. defaults to silver. For example,
{{cot|This is the title text|b-color=#F0F2F5}} - padding
- Sets the padding on the collapsed material in the colored area. Defaults to 8px. For example,
{{cot|This is the title text|padding=16px}} - width
- Sets the width of the overall template. Use
|width=50%, not|Width=50%as upper case "W" doesn't work. Or|width=200px(if you omit "px" it doesn't work). - 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,
{{cot|This is the title text|border2=2px}} - bg2
- Sets background of the box that appears when template is expanded; defaults to white. For example,
{{cot|This is the title text|bg2=#F0F2F5}} - indent
- indents the box from the left of the page. Use:
|indent=50pxnot|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.
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, {{cot|Section header}}
Examples
- Adding a box title (if omitted, default is 'Extended content') -
{{cot|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 -
{{cot|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 -
{{cot|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}} or {{cot|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}} or {{cot|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 -
{{cot|padding=40px}}
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:
{{cot}}
==Section header==
Sample contents text
{{cob}}
must be rewritten as:
{{cot|Section header}}
Sample contents text
{{cob}}
The end result:
Section header
|
|---|
|
Sample contents text |
Redirects
To Collapse top:
To Collapse bottom:
- {{cob}}
- {{hab}}
- {{hidden archive bottom}}
See also
- {{collapse}}
- {{collapse bottom}}
- {{discussion top}}
- {{hidden archive top}}
