Template:Collapsible option/doc

{{Collapsible option}} provides a standardised message for  transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter |state =.

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}}, if the template is coded that way. To indicate this in the {{Collapsible option}} message, add the parameter |statename = optional. This modifies the message so that it reads (if it were used for itself):

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}}
  • shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
  • shows the template in its expanded state if there are no other collapsible items on the page

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.

This possibility is enabled by including:

• {{{1|}}} as part of a collapsible template's |state = parameter – for instance, as |state = {{{state|{{{1|}}}}}} or |state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc.
• <noinclude>,<includeonly>as part of a collapsible template's state argument – for instance, as |state = {{{state<includeonly>|collapsed</includeonly>}}}

If, however, the template includes collapsible sections within itself (e.g. {{Navbox with collapsible groups}}), then enabling this possibility may introduce ambiguity as regards what is to be collapsed or expanded. In those instances, therefore, the requirement to use |state = should be retained.

Changing the default state

To change the default state {{Collapsible option}} uses, add the parameter |default = collapsed or |default = expanded accordingly. To restore the default, remove any |default = previously included.

The |default = collapsed option must not be used in main article content in mainspace, e.g. to hide tables of information, or to cram extraneous details into infoboxes. (For more information, see Wikipedia:Manual of Style#Scrolling lists and collapsible content § Notes.) This option is permissible in navboxes, which are not part of the article content Template:Lang.

Slashes and the nobase parameter

If the template name given to {{Collapsible option}}</nowiki> includes a forward-slash (virgule) character – / – then the parameter |nobase = (set to on, true, etc.) will need to be added so that the name is displayed correctly (i.e., so that {{PAGENAME}} rather than the default {{BASEPAGENAME}} is used to display it).

See also

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