Template:Collapsible option/doc
|
Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
This is a documentation subpage for Template:Collapsible option. It contains usage information, categories and other content that is not part of the original template page. |
 |
This template uses material from the Wikipedia template Template:Collapsible option/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors). | Error creating thumbnail: /bin/bash: rsvg-convert: command not found |
{{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 tags) or on the template's {{documentation subpage}}.
Contents
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}}. 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:
|state=collapsedto show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g.{{Collapsible option |state=collapsed}}|state=expandedto show the template in its expanded state, i.e. fully visible – e.g.{{Collapsible option |state=expanded}}
Unless set otherwise (see the |state= parameter in the template's code), the template's default state is expanded.
{{{1|}}} as part of a collapsible template's state parameter – for instance, as |state={{{state|{{{1|}}}}}} or |state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc. 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 reported
To change the default state {{Collapsible option}} reports in its second bullet-point, add the parameter |default=collapsed or |default=expanded accordingly. To restore the default report, remove any |default= previously included.
nobase
If the template name given to {{Collapsible option}} includes a (forward-)slash character ("/"), 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
