Misplaced Pages

This is an old revision of this page, as edited by Sardanaphalus (talk | contribs) at 16:42, 1 November 2014 (Second attempt to restore phrasing that doesn't suggest this feature only available with one-parameter templates. If this version also not to taste, please act positively and constructively.). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

How to manage this template's initial visibility
To manage this template's visibility when it first appears, add the parameter...

|state=collapsed ..........  to show the template in its collapsed state, i.e. hidden apart from its titlebar;

|state=expanded ............  to show the template in its expanded state, i.e. fully visible;

|state=autocollapse ....  to show the template in its collapsed state but only if there is another template of the same type on the page.

Unless set otherwise (see thestateparameter in the template's code), the template's default state isautocollapse.

This template is used on approximately 142,000 pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

{{Collapsible option}} is a utility template that provides a standardised message for transclusion on template documentaion pages for templates whose collapsibility may be managed by the parameter |state=.

It can be used on either the template page itself (wrapped within <noinclude>...</noinclude> tags), but it is almost always better to place it in the template's {{documentation subpage}}.

Indicating optional use of state name

The factual accuracy of this template may be compromised due to out-of-date information. The reason given is: Removed in 2015. Please help update this template to reflect recent events or newly available information. Relevant discussion may be found on the talk page. (December 2024)

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

How to manage this template's initial visibility
To manage this template's visibility when it first appears, add the parameter...

|collapsed ..........  to show the template in its collapsed state, i.e. hidden apart from its titlebar;

|expanded ............  to show the template in its expanded state, i.e. fully visible;

|autocollapse ....  to show the template in its collapsed state but only if there is another template of the same type on the page.

Unless set otherwise (see thestateparameter in the template's code), the template's default state isautocollapse.

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 Misplaced Pages:Manual of Style § Scrolling lists and collapsible content.) This option is permissible in navboxes, which are not part of the article content per se.

Slashes and the nobase parameter

If the template name given to {{Collapsible option}} 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}}, which includes this template
• {{Collapsible lists option}}
• {{Collapsible sections option}}
• Collapsing tables and more

• Documentation shared content templates
• Misplaced Pages metatemplates