Difference between revisions of "Template:Collapsible option"
(Created as needed.) |
m (Corrected) |
||
Line 1: | Line 1: | ||
'''How to manage this template's initial visibility'''<br /> | '''How to manage this template's initial visibility'''<br /> | ||
To manage this template's visibility when it first appears, | To manage this template's visibility when it first appears, add the parameter: | ||
:{{para|state|collapsed}} to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=collapsed}}</nowiki></code> | :{{para|state|collapsed}} to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=collapsed}}</nowiki></code> | ||
:{{para|state|expanded}} to show the template in its expanded state, i.e. fully visible – e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=expanded}}</nowiki></code> | :{{para|state|expanded}} to show the template in its expanded state, i.e. fully visible – e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=expanded}}</nowiki></code> |
Revision as of 18:07, 16 February 2016
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 – e.g.{{BASEPAGENAME |state=collapsed}}
|state=expanded
to show the template in its expanded state, i.e. fully visible – e.g.{{BASEPAGENAME |state=expanded}}
|state=autocollapse
to show the template in its collapsed state but only if there is another template of the same type on the page – e.g.{{BASEPAGENAME |state=autocollapse}}
Unless set otherwise (see the |state=
parameter in the template's code), the template's default state is autocollapse
.
{{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>...</noinclude>
tags) or on the template's {{documentation subpage}}.
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=collapsed
to show the template in its collapsed state, i.e. hidden apart from its titlebar – e.g.{{Collapsible option |state=collapsed}}
|state=expanded
to show the template in its expanded state, i.e. fully visible – e.g.{{Collapsible option |state=expanded}}
|state=autocollapse
to show the template in its collapsed state but only if there is another template of the same type on the page – e.g.{{Collapsible option |state=autocollapse}}
|state=
parameter in the template's code), the template's default state is autocollapse
.
{{{1|}}}
as part of a collapsible template'sstate
parameterTemplate:Spaced ndashfor instance, as|state={{{state|{{{1|}}}}}}
or|state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}
, etc.<noinclude>
,<includeonly>
as part of a collapsible template'sstate
argumentTemplate:Spaced ndashfor instance, as|state={{{state<includeonly>|collapsed</includeonly>}}}
|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 Template:Wikivar rather than the default Template:Wikivar is used to display it).
See also
The above documentation is transcluded from Template:Collapsible option/doc. (edit | history) Editors can experiment in this template's sandbox (create) and testcases (create) pages. Please add categories and interwikis to the /doc subpage. Subpages of this template. |