Template:Collapsible option/doc
| File:Edit-copy green.svg | 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. |
{{Collapsible option}} provides a standardised message for transclusion on template pages whose templates include a state parameter through which their collapsibility may be managed.
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
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 . To indicate this in the {{Collapsible option}} message, add the parameter |state=state}}|statename=optional. This modifies the message so that it reads:
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}}
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 its state parameter, e.g. as | state = {{{state|{{{1|}}}}}} or | state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc. If, however, the template features collapsible sections within itself (e.g. {{Navbox with collapsible groups}}) then enabling this possibility may introduce ambiguity as regards what is to be collapsed, expanded, etc. The need to use "|state=" in these instances should, therefore, be retained. )Changing the default state reported
To change the default state {{Collapsible option}} reports in its fourth bullet-point, add the parameter |default=collapsed or |default=expanded accordingly, or, to restore the autocollapse report, remove any |default= included when {{Collapsible option}} is used.
See also