Template:Collapsible option/doc

From blackwiki
< Template:Collapsible option
Revision as of 23:42, 18 May 2012 by imported>Funandtrvl (updte, ce)
Jump to navigation Jump to search

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

Usage

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

To change the default from "autocollapse", use the |state= parameter.

Examples

Default

{{Collapsible option}}
will display as:
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.

Options

To change the state default, use either "collapsed" or "expanded", as in the following:
{{Collapsible option |state=collapsed}}

will display as:
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.

See also