Template:Collapsible option/doc

This is the stable version, checked on 20 October 2020. Template changes await review.

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

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 Template:Para 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 Template:Para. 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 Template:Para parameter may be used:

  • Template:Para: {{Collapsible option/doc|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar
  • Template:Para: {{Collapsible option/doc|state=expanded}} to show the template expanded, i.e., fully visible
  • Template:Para: {{Collapsible option/doc|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 Template:Para parameter in the template on this page is not set, the template's initial visibility is taken from the Template:Para parameter in the Collapsible option template. For the template on this page, that currently evaluates to autocollapse.

This possibility is enabled by including:

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 Template:Para should be retained.

Changing the default state

To change the default state {{Collapsible option}} uses, add the parameter Template:Para or Template:Para accordingly. To restore the default, remove any Template:Para previously included.

The Template:Para 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.

  1. REDIRECT Template:Crossreference

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 Template:Para (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

For more detail see wikipedia page wikipedia:Template:Collapsible option


This content is in the Template Namespace. Used for page-templates that can be re-used across the wiki.