Fyrimynd:Collapse/doc

Dokumentation

Hetta er dokumentatiónssíðan fyri Fyrimynd:Collapse.

Henda síðan er ikki neyðturviliga hugsað at skula vísast beinleiðis. Um hon nýtir variablar, so kunnu nøkur leinki sýnast sum brotin. Tú mást ikki útskifta variablarnir við beinleiðis tittlar ella URL.

The {{collapse|folding text}} template is used for placing collapse boxes around short discussions and bits of discussions. To fold long discussion threads, use {{Collapse top}}... lots of text ...{{Collapse bottom}}.

This template should only be used in accordance with the Wikipedia:refactoring guideline; it should never be used to end a discussion over the objections of other editors, except in cases of unambiguous disruptive editing.

Usage

Note: {{Collapse}} needs to be substed in order for the time stamp functionality to work properly.

{{Collapse|1=Discussion text to be put into box.|2=Optional custom heading}}

It is definitely safest to use the named |1= and |2= parameters, because otherwise any "=" character will break the template.

The bg parameter

The bg parameter is optional. It changes the background color. Use web color values (e.g. #F0F2F5).

Example

{{Collapse|1=Discussion text to be put into box.|bg=#F0F2F5}} creates:

The padding parameter

The padding parameter adjusts the amount of cell padding (defaults to 8px):

{{Collapse|1=Discussion text to be put into box.|padding=20px}} creates the following (expand the box to see the border padding effect):

Around header text

When used with a section of text, include the section header in the collapsed portion of text. For example, given:

== Heading ==
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.

Replace with:

{{subst:Collapse|1=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.|2=Heading}}

The expand parameter

Simply add |expand=yes to have the box show up in expanded form with a "hide" link, instead of collapsed form with a "show" link. Other options: |expand= yes, y, expand, expanded, uncollapse, uncollapsed. Note: |expand=no will fold the box (default).

When content includes tables

This template frequently breaks when used around content that consists of or includes wikitables. Such content can be made collapsible by using the {{collapse top}} and {{collapse bottom}} templates instead of {{collapse}}.

TemplateData

Hetta er TemplateData dokumentatiónin fyri hesa fyrimynd, ið verður brúkt av VisualEditor og øðrum tólum.

Collapse

Creates a collapsible box that allows its content to be hidden or revealed on user's command. It is used to reduce clutter.

Template parameters
Parameter		Description	Type	Status
Contents	`1`	Contents of the box	Content	required
Title	`2`	Text of title bar. Defaults to "Extended contents".	String	suggested
Expanded by default?	`expand`	Setting to "yes, y, expand, uncollapse") will cause the box to show its contents by default. Any other value (and omitting this parameter) causes the box to be collapsed by default (its contents hidden). Default yes	String	optional
Border width	`border`	Width of the border. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px. Default 1px	String	optional
Title bar's color	`bg`	Color of the title bar. Can be set any valid CSS color value but please take care that text would remain black.	String	optional
Padding	`padding`	Width of the padding, the empty space between border and the contents. Accepts a number (e.g. 2) followed immediately with a CSS-compatible unit of measurement. (e.g. "px") Example: 2px. Default 8px	Unknown	optional