Template:Collapsible option

From Wikibooks, open books for an open world
Jump to navigation Jump to search
How to manage this template's visibility
  • Use {{Template name |state=collapsed}}  to show this template in its collapsed (hidden) state.
  • Use {{Template name |state=expanded}}  to show this template in its expanded (fully visible) state.
  • Use {{Template name |state=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.
Template documentation[edit] [history] [purge]

{{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[edit]

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 (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.
( 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[edit]

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[edit]