Template:Collapsible option/doc

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).

It may be used on either the template page itself (wrapped within <noinclude></noinclude> tags), or on the template's {{documentation subpage}}.

Usage

Indicating optional use of state name

If, in a template where {{collapsible option}} has been transcluded, that template's state parameter has been enabled such that it need not be named when the template is called – i.e., the state parameter includes {{{1| }}}, e.g.:

|state = {{{state|{{{1|}}}}}}

or

|state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}

etc

then:

{{collapsible option |statename=optional}}

removes the instances of |state= from the {{collapsible option}} message, and will display as:

How to manage this template's visibility

• Use {{Collapsible option |collapsed}}  to show this template in its collapsed (hidden) state.
• Use {{Collapsible option |expanded}}  to show this template in its expanded (fully visible) state.
• Use {{Collapsible option |autocollapse}}  to show this template in its collapsed (hidden) state only if there is another template of the same type on the page.
• Unless set otherwise (see state parameter within the template's code), autocollapse is the default state.

Changing default

To change the state default from "autocollapse", use either "collapsed" or "expanded", as in the following:

{{Collapsible option |state=collapsed}}

will display as:

How to manage this template's visibility

• Use {{Collapsible option |state=collapsed}}  to show this template in its collapsed (hidden) state.
• Use {{Collapsible option |state=expanded}}  to show this template in its expanded (fully visible) state.
• Use {{Collapsible option |state=autocollapse}}  to show this template in its collapsed (hidden) state only if there is another template of the same type on the page.
• collapsed has been set as the default state.

See also

• {{Collapsible lists option}}
• {{Collapsible sections option}}