Template:Collapsible option/doc
| icon | This is a documentation subpage for Template:Collapsible option. It may contain usage information, categories and other content that is not part of the original template page. |
| Warning | This template is used on approximately 149,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 documentation 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}}.
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. 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