Template:Collapse top

ExpandExtended content
The following content has been placed in a collapsed box for improved usability.

Template documentation

The {{Collapse top}} template, and its paired template {{Collapse bottom}}, are used for placing a collapse box around a talk page discussion.

Usage

Place {{Collapse top}} and {{Collapse bottom}} around the text to be collapsed. For example:

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

produces:

ExpandThis 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= (or first unnamed parameter), |title=, |reason=, |header=, |heading=: 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 non-empty value supplied to this parameter will have this effect (i.e. |warning= 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 (in RTL languages, along the right margin instead).; By default, text is centered, specifically between the left edge of the green box and the left edge of the "show" link.; Any non-empty value supplied to this parameter will have this effect (i.e. |left= will not work as expected).
|expand=yes: Will leave the material uncollapsed with the border and coloring. Default is to collapse the material.; Any non-empty value supplied to this parameter will have this effect (i.e. |expand= will not work as expected).
|bg=: Sets the background color of the title of the collapsible bar. Defaults to "#F8FCFF", a whitish color. Named colors are listed at List of colors.; For example, {{Collapse top|This is the title text|bg=#008000}} or {{Collapse top|This is the title text|bg=green}} (numeric HTML color codes require the leading #).
|fc=: Sets the font color of the title of the collapsible bar. Defaults to "black".; 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 8px.
|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 (#FFF).; 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 the reason).

Examples

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

ExpandThis is the title text

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

ExpandThis is the title text

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

ExpandThis is the title text

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

Expand<translate> Extended content</translate>

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

Expand<translate> Extended content</translate>

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

Expand<translate> Extended content</translate>

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:

ExpandSection header
Sample contents text

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Collapse top

<templatedata> { "params": { "1": { "aliases": [ "title", "heading", "header", "reason", "result" ], "label": { "en": "Title", "cs": "Titul", "fr": "Titre" }, "description": { "en": "Main title of collapsed box", "cs": "Hlavní název sbaleného boxu", "fr": "Titre principal de la boîte repliée" }, "example": { "en": "This is the title text", "cs": "Toto je text titulku", "fr": "Ceci est le texte du titre" }, "required": true }, "2": { "label": { "en": "Custom warning line", "cs": "Vlastní výstražná linka", "fr": "Ligne d'avertissement personnalisée" }, "description": { "en": "Will override the standard warning line, and make the 'warning' parameter unnecessary", "cs": "Přepíše standardní varovný řádek a učiní parametr 'varování' zbytečným", "fr": "Remplace la ligne d'avertissement standard , et rend inutile le paramètre 'avertissement' " }, "example": { "en": "This is a custom warning line", "cs": "Toto je vlastní varovný řádek", "fr": "Ceci est une ligne d'avertissement personnalisée " }, "type": "string" }, "indent": { "description": { "en": "Indents the box from the left of the page", "cs": "Odsadí rámeček z levé části stránky", "fr": "Indente la boîte à partir de la gauche de la page " }, "type": "unknown", "autovalue": "0px", "label": { "cs": "Odsazení", "fr": "Indentation" } }, "expand": { "aliases": [ "collapse" ], "description": { "en": "Using expand=yes or collapse=no will leave the material uncollapsed with the border and coloring", "cs": "Pomocí rozbalit=ano nebo sbalit=ne zůstane prvek nesbalený s okrajem a zabarvením", "fr": "expand=yes ou collapse=no laisse le matériel non replié avec son bord et sa couleur " }, "example": { "en": "true", "cs": "true", "fr": "true" }, "type": "string", "autovalue": "", "label": { "cs": "Rozšíření", "fr": "Expansion" } }, "border": { "label": { "en": "Border width (px)", "cs": "Šířka okraje (px)", "fr": "Largeur de la bordure (px)" }, "description": { "en": "Sets the width of the border line on the collapsed material", "cs": "Nastaví šířku hraniční čáry na složeném prvku", "fr": "Définit la largeur de la bordure du matériel replié" }, "example": { "en": "2px", "cs": "2px", "fr": "2px" }, "default": { "en": "1px", "cs": "1px", "fr": "1px " }, "autovalue": "" }, "b-color": { "label": { "en": "Border color", "cs": "Barva ohraničení", "fr": "Couleur de la bordure" }, "description": { "en": "Sets the border color", "cs": "Nastaví barvu ohraničení", "fr": "Définit la couleur de la bordure" }, "example": { "en": "#F0F2F5", "cs": "#F0F2F5", "fr": "#F0F2F5" }, "default": { "en": "Silver", "cs": "Silver", "fr": "Silver" } }, "width": { "label": { "en": "Template width (px or %)", "cs": "Šířka šablony (px nebo %)", "fr": "Largeur du modèle (px ou %)" }, "description": { "en": "Sets the width of the overall template", "cs": "Nastaví šířku celé šablony", "fr": "Définit la largeur totale du modèle" }, "example": { "en": "50%", "cs": "50%", "fr": "50%" } }, "bg": { "label": { "en": "Collapsed material background color", "cs": "Barva pozadí sbaleného prvku", "fr": "Couleur de fond du matériel replié" }, "description": { "en": "Sets the background color of the collapsed material", "cs": "Nastaví barvu pozadí sbaleného prvku", "fr": "Définit la couleur de fond du matériel replié" }, "example": { "en": "#F0F2F5", "cs": "#F0F2F5", "fr": "#F0F2F5" }, "default": { "en": "#CFC", "cs": "#CFC", "fr": "#CFC" } }, "left": { "label": { "en": "Alight along the left margin (true or blank)", "cs": "Zarovnat k levému okraji (true nebo prázdný)", "fr": "Alignement le long de la marge gauche (true ou vide)" }, "description": { "en": "Will align the 'parameter 1 title' along the left margin", "cs": "Zarovná 'název parametru 1' k levému okraji", "fr": "Aligne le 'parameter 1 titre' le long de la marge gauche" }, "example": { "en": "true", "cs": "true", "fr": "true" }, "type": "string", "default": { "en": "", "cs": "", "fr": "" } }, "fc": { "label": { "en": "Title font color", "cs": "Barva písma názvu", "fr": "Couleur de la fonte du titre" }, "description": { "en": "Sets the font color of the title of the collapsible bar", "cs": "Nastaví barvu písma názvu rozbalovací lišty", "fr": "Définit la couleur de la fonte du titre de la barre repliable" }, "example": { "en": "#F0F2F5", "cs": "#F0F2F5", "fr": "#F0F2F5" }, "default": { "en": "Black", "cs": "Black", "fr": "Black" } }, "warning": { "label": { "en": "Warning (true or blank)", "cs": "Upozornění (true nebo prázdné)", "fr": "Avertissement (true ou vide)" }, "description": { "en": "Will display a default warning line under the main title which reads \"The following is a closed debate. Please do not modify it.\"", "cs": "Pod hlavním názvem se zobrazí výchozí varovný řádek, který zní \"Následuje uzavřená debata. Neupravujte jej, prosím.\"", "fr": "Affiche une ligne d'avertissement par défaut sous le titre principal indiquant \"La suite est une discussion qui est terminée. Veuillez ne pas la modifier.\"" }, "example": { "en": "true", "cs": "true", "fr": "true" } }, "border2": { "label": { "en": "Expanded box border size & color", "cs": "Velikost a barva okraje rozbaleného pole", "fr": "Bordure de la boîte dépliée largeur et couleur" }, "description": { "en": "Sets the border of the box that appears when template is expanded", "cs": "Nastaví ohraničení rámečku, který se zobrazí po rozbalení šablony", "fr": "Définit le bord de la boîte qui apparaît lorsque le modèle est déplié" }, "example": { "en": "2px", "cs": "2px", "fr": "2px" }, "default": { "en": "1px silver", "cs": "1px silver", "fr": "1px silver" } }, "padding": { "label": { "en": "Padding (px)", "cs": "Výplň (px)", "fr": "Remplissage (px)" }, "description": { "en": "Sets the padding on the collapsed material in the colored area", "cs": "Nastaví výplň na složeném prvku v barevné oblasti", "fr": "Définit l'espacement sur le matériel replié de la zone colorée" }, "example": { "en": "16px", "cs": "16px", "fr": "16px" }, "default": { "en": "8px", "cs": "8px", "fr": "8px" } }, "bg2": { "label": { "en": "Expanded box color", "cs": "Barva rozbaleného pole", "fr": "Couleur de la boîte dépliée" }, "description": { "en": "Sets background of the box that appears when template is expanded", "cs": "Nastaví pozadí pole, které se zobrazí po rozbalení šablony", "fr": "Définit la couleur de fond de la boîte qui apparaît lorsque le modèle est déplié" }, "example": { "en": "#F0F2F5", "cs": "#F0F2F5", "fr": "#F0F2F5" }, "default": { "en": "white", "cs": "white", "fr": "white" } } }, "description": {

"en": "Use in conjunction with

. Will collapse text in between the two templates.", "cs": "Používejte ve spojení s

. Sbalí text mezi dvěma šablonami.", "fr": "A utiliser en conjonction avec . Va replier le texte qui se trouve entre les deux modèles."

} } </templatedata>

Template:Collapse top

Contents

Usage

Parameters

Examples

TemplateData

See also