Template:Collapsible option/doc

{{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 |state=state}}. To indicate this in the {{Collapsible option}} message, add the parameter |statename=optional. This modifies the message so that it reads:

How to manage this template's visibility

• Use {{Collapsible option |collapsed}} to show this template in its collapsed (i.e. hidden) state.

Use {{Collapsible option |expanded}} to show this template in its expanded (i.e. fully visible) state.

Use {{Collapsible option |autocollapse}} to show this template in its collapsed state only if there is another template of the same type on the page.

• Unless set otherwise (see the state parameter within the template's code), the template's default state is "autocollapse".

( This possibility is enabled in a collapsible template by including {{{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

• {{Collapsible lists option}}
• {{Collapsible sections option}}
• Help:Collapsing