Majestix: 1 revision imported: Initial Setup

2026-04-12T06:16:23Z

1 revision imported: Initial Setup

← Older revision		Revision as of 08:16, 12 April 2026
(No difference)

en>RogueScholar: Create initial template documentation subpage

2025-05-02T03:01:46Z

Create initial template documentation subpage

New page

{{Documentation subpage}}
This template, {{Template link general|plaincode=on|Collapse}}, creates a collapsible container for page content that would benefit from an (optional) ability to be hidden from view, with the ability to appear in either the collapsed or expanded state by default.

== Usage ==
In its simplest functional use case, the template's invocation need only include the parameters for the container's title and contents, taking the form:
:{{Template link general|bold=on|code=on|nolink=on|Collapse|title={{Var|Box title}}|content={{Var|The contents of the box…}}}}

=== Blank example blocks ===
==== With common parameters only ====
Below is an example of the template formatted as a block with the most commonly used parameters, plus guidance on valid values where applicable; please delete all unused parameters before saving if copied and pasted.
<syntaxhighlight lang="wikitext" style="width: fit-content;">
{{Collapse
| title =
| expand = 
| background-c =
| align =
| padding =
| content = 
}}
</syntaxhighlight>

==== With all parameters ====
Below is an example of the template formatted as a block with all possible named parameters, plus guidance on valid values where applicable; please delete all unused parameters before saving if copied and pasted.
<syntaxhighlight lang="wikitext" style="width: fit-content;">
{{Collapse
| title =
| expand = 
| background-c =
| color =
| font-size =
| align =
| padding =
| width =
| margin =
| clear = 
| border-w = 
| border-s = 
| border-c =
| header-align = 
| header-c =
| header-bw = 
| header-bs = 
| header-bc =
| header-fc =
| header-fs =
| header-fw = 
| header-p =
| class =
| style =
| content = 
}}
</syntaxhighlight>

== TemplateData ==
{{TemplateData header}}
<templatedata>{
"description": "Places page content that consumes excess vertical space or is likely to interest only a subset of readers within a collapsible box that can appear in either state by default, keeping it in place and accessible without detriment to the overall layout or readability",
"format": "{{_\n | ____________ = _\n}}",
"paramOrder": [
"title",
"content",
"expand",
"header-c",
"background-c",
"header-fc",
"color",
"header-fw",
"header-fs",
"font-size",
"header-align",
"align",
"header-p",
"padding",
"width",
"margin",
"clear",
"header-bw",
"border-w",
"header-bs",
"border-s",
"header-bc",
"border-c",
"class",
"style"
],
"params": {
"expand": {
"label": "Default expansion state",
"description": "When assigned the value 'no', the container's default appearance becomes its collapsed state",
"example": "no",
"type": "boolean",
"default": "yes"
},
"class": {
"label": "Extra CSS classes",
"description": "Adds additional class names to the top-level 'div' HTML container element",
"example": "toccolours",
"type": "line"
},
"background-c": {
"label": "Background color",
"description": "The background color for the box's contents, which also narrowly surrounds the title in the collapsed state; must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.).",
"example": "#abcdef",
"type": "line",
"default": "white"
},
"border-w": {
"label": "Border width",
"description": "Thickness of the box's outer border, must be a valid CSS length value with unit suffix or one of: 'thin', 'medium' or 'thick'",
"example": "2px",
"type": "line",
"suggestedvalues": [
"thin",
"medium",
"thick"
],
"default": "thin"
},
"border-s": {
"label": "Border style",
"description": "Style of the box's outer border",
"example": "double",
"type": "line",
"suggestedvalues": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset"
],
"default": "solid"
},
"border-c": {
"label": "Border color",
"description": "Color of the box's outer border, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.)",
"example": "darkslateblue",
"type": "line",
"default": "#aaa"
},
"clear": {
"label": "Float clearance",
"description": "Forces box to move below any floating elements on either or both page margins that prevent it from extending there",
"example": "both",
"type": "line",
"suggestedvalues": [
"none",
"left",
"right",
"both",
"inline-start",
"inline-end"
],
"default": "both"
},
"color": {
"label": "Text color",
"description": "Font text color of the box's content and, optionally, its title; must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.).",
"example": "dimgray",
"type": "line",
"default": "#222"
},
"margin": {
"label": "Margin width",
"description": "Defines the size of the collapsible box's margins from other elements on the page, must consist of 1–4 valid CSS length values with unit suffix",
"example": "1rem",
"type": "line",
"suggestedvalues": [
"auto",
"0.25rem",
"0.5rem",
"0.75rem",
"1rem",
"1.25rem",
"1.5rem",
"1.75rem",
"2rem"
],
"default": "0.75rem auto 1.25rem"
},
"width": {
"label": "Width",
"description": "The width of the collapsible box, either as an exact CSS length value with unit suffix or relative percentage of the page or viewport",
"example": "50vw",
"type": "line",
"default": "100%"
},
"header-c": {
"label": "Title background color",
"description": "Background color of the box title's rectangular element, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.)",
"example": "goldrenrod",
"type": "line",
"default": "#eaecf0"
},
"header-bw": {
"label": "Title border width",
"description": "Thickness of the box title rectangular element's border, must be a valid CSS length value with unit suffix or one of: 'thin', 'medium' or 'thick'",
"example": "medium",
"type": "line",
"suggestedvalues": [
"thin",
"medium",
"thick"
],
"default": "thin"
},
"header-bs": {
"label": "Title border style",
"example": "ridge",
"type": "line",
"suggestedvalues": [
"none",
"hidden",
"dotted",
"dashed",
"solid",
"double",
"groove",
"ridge",
"inset",
"outset"
],
"description": "Style of the box title rectangular element's border",
"default": "solid"
},
"header-bc": {
"label": "Title border color",
"description": "Color of the box title rectangular elements's outer border, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.)",
"example": "navy",
"type": "line",
"default": "#a4aab080"
},
"header-fc": {
"label": "Title text color",
"description": "Font text color of the box's title, must be a valid CSS color value (named, hexadecimal code, RGB decimals, etc.)",
"example": "indigo",
"type": "line",
"default": "black"
},
"header-fs": {
"label": "Title text size",
"description": "Size of the box's title text font, must be a valid CSS length value with unit suffix or a relative size keyword",
"type": "line",
"suggestedvalues": [
"xx-small",
"x-small",
"small",
"medium",
"large",
"x-large",
"xx-large",
"xxx-large"
],
"default": "0.95rem"
},
"font-size": {
"label": "Text size",
"description": "Font size of the text content contained within the box, must be a valid CSS length value with unit suffix or a relative size keyword",
"type": "line",
"suggestedvalues": [
"xx-small",
"x-small",
"small",
"medium",
"large",
"x-large",
"xx-large",
"xxx-large"
],
"default": "0.85rem"
},
"header-p": {
"label": "Title padding",
"description": "Sets the padding of the box title's rectangular element, or the distance from which it extends in all four directions beyond the title text; must be composed of 1–4 valid CSS length value(s) with unit suffix(es)",
"example": "0.4rem",
"type": "line",
"default": "0.15rem"
},
"header-align": {
"label": "Title alignment",
"description": "Sets the horizontal alignment of the box's title within its rectangular element",
"example": "left",
"type": "line",
"suggestedvalues": [
"start",
"end",
"left",
"right",
"center",
"justify",
"match-parent",
"justify-all"
],
"default": "center"
},
"title": {
"label": "Title",
"description": "The heading which describes the box's contents and is the only thing shown when in the collapsed state",
"example": "Some additional technical details…",
"type": "line",
"default": "{{PAGENAME}}",
"required": true,
"aliases": [
"2"
]
},
"padding": {
"label": "Content padding",
"description": "Defines the thickness of the null space between the box's contents and its borders, must be composed of 1–4 valid CSS length value(s) with unit suffix(es)",
"example": "1rem",
"type": "line",
"default": "0.4em 0.8em 0.2em"
},
"align": {
"label": "Content alignment",
"description": "Sets the horizontal alignment of the box's contents",
"example": "justify",
"type": "line",
"suggestedvalues": [
"start",
"end",
"left",
"right",
"center",
"justify",
"match-parent",
"justify-all"
],
"default": "none"
},
"content": {
"aliases": [
"1"
],
"label": "Content",
"description": "The page content to appear within the collapsible box",
"example": "Lorem ipsum dolor sit amet,…",
"type": "content",
"required": true
},
"style": {
"label": "Extra CSS style declarations",
"description": "Defines additional CSS style declarations to be added to the collapsible container's outer table element, multiple declarations must be semicolon-delimited",
"example": "white-space: nowrap;",
"type": "string"
},
"header-fw": {
"label": "Title font weight",
"description": "Sets the thickness of the title text font, must be an unsigned (positive) integer between 100 and 900, inclusive, or a relative CSS font-weight keyword",
"example": "500",
"type": "line",
"suggestedvalues": [
"normal",
"bold",
"lighter",
"bolder",
"100",
"200",
"300",
"400",
"500",
"600",
"700",
"800",
"900"
],
"default": "bold"
}
}
}</templatedata>

== See also ==
* {{Template link general|Hidden}} – functionally very similar, but with different aesthetics
* {{Template link general|Hidden archive top}} (and {{Template link general|Hidden archive bottom}}) – also similar in function, but meant specifically for pages in Talk namespaces with an included admonition not to disturb the contents in the interests of maintaining a faithful archive of past events

These template pairs also produce a similar content container, but are more compatible with complex wiki markup structures:
* {{Template link general|Collapse top}} (and {{Template link general|Collapse bottom}})
* {{Template link general|Hidden begin}} (and {{Template link general|Hidden end}})

<includeonly>{{Sandbox other||

[[Category:Formatting templates]]
}}</includeonly>

Template:Collapse/doc - Revision history

Majestix: 1 revision imported: Initial Setup

en>RogueScholar: Create initial template documentation subpage