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. |
The {{collapsible option}} template gives a standardised message for transclusion on template pages whose templates include a state parameter (through which their collapsibility may be managed).
Contents
Usage
It may be used on either the template page itself (wrapped within <noinclude></noinclude> tags), or on the template's {{documentation}} subpage.
To change the default from "autocollapse", use the |state= parameter.
Examples
Default
{{Collapsible option}}
will display as:
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.
Options
To change the state default, use either "collapsed" or "expanded", as in the following:
{{Collapsible option |state=collapsed}}
will display as:
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.
See also