Template:Collapsible option/doc
This is a documentation subpage for Template:Collapsible option. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 107,000 pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing any changes on the talk page before implementing them. |
{{Collapsible option}} provides a standardised message for transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter state
.
It may be used on either the template page itself (wrapped within <noinclude>...</noinclude>
tags) or on the template's {{documentation subpage}}.
Indicating optional use of state name[edit | hide | hide all]
The state
parameter used to manage collapsible templates need not always be named explicitly, i.e. {{[Template name]|state}} can be the same as {{[Template name]|state=state}}. To indicate this in the {{Collapsible option}} message, add the parameter |statename=optional
. This modifies the message so that it reads (if it were used for itself):
Initial visibility: currently defaults to autocollapse
To set this template's initial visibility, the |state=
parameter may be used:
|state=collapsed
: {{Collapsible option|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar|state=expanded
: {{Collapsible option|state=expanded}} to show the template expanded, i.e., fully visible|state=autocollapse
: {{Collapsible option|state=autocollapse}}- shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
- shows the template in its expanded state if there are no other collapsible items on the page
If the |state=
parameter in the template on this page is not set, the template's initial visibility is taken from the |default=
parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse
.
{{{1|}}}
as part of a collapsible template'sstate
parameter – for instance, as|state={{{state|{{{1|}}}}}}
or|state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}
, etc.<noinclude>
,<includeonly>
as part of a collapsible template'sstate
argument – for instance, as|state={{{state<includeonly>|collapsed</includeonly>}}}
|state=
should be retained.)Changing the default state[edit | hide]
To change the default state {{Collapsible option}} uses, add the parameter |default=collapsed
or |default=expanded
accordingly. To restore the default, remove any |default=
previously included.
nobase[edit | hide]
If the template name given to {{Collapsible option}} includes a (forward-)slash character ("/"), the parameter |nobase=
(set to "on", "true", etc.) will need to be added so that the name is displayed correctly (i.e. so that {{PAGENAME}}
rather than the default {{BASEPAGENAME}}
is used to display it).
See also[edit | hide]