Difference between revisions of "Template:Collapsible option/doc"
imported>Sardanaphalus (→Changing the default state reported: correction, split sentence) |
imported>GermanJoe m (→Indicating optional use of state name: fix - whitespace in doc aswell (see talkpage)) |
||
| Line 7: | Line 7: | ||
===Indicating optional use of ''state'' name=== | ===Indicating optional use of ''state'' name=== | ||
| − | The{{plaincode|state}}parameter used to manage collapsible templates need not always be named explicitly, i.e. {{plaincode|{{braces|<span style{{=}}"padding-left:0.2em;padding-right:0.6em;">[''Template name'']</span>{{!}}''state''}}}} can be the same as {{plaincode|{{braces|<span style{{=}}"padding-left:0.2em;padding-right:0.6em;">[''Template name'']</span>{{!}}state=''state''}}}}. To indicate this in the <nowiki>{{Collapsible option}}</nowiki> message, add the parameter {{para<!--|plain-->|statename|optional}}. This modifies the message so that it reads (if it were used for itself): | + | The {{plaincode|state}} parameter used to manage collapsible templates need not always be named explicitly, i.e. {{plaincode|{{braces|<span style{{=}}"padding-left:0.2em;padding-right:0.6em;">[''Template name'']</span>{{!}}''state''}}}} can be the same as {{plaincode|{{braces|<span style{{=}}"padding-left:0.2em;padding-right:0.6em;">[''Template name'']</span>{{!}}state=''state''}}}}. To indicate this in the <nowiki>{{Collapsible option}}</nowiki> message, add the parameter {{para<!--|plain-->|statename|optional}}. This modifies the message so that it reads (if it were used for itself): |
<div style="clear:both;margin:1.0em 0;background:whitesmoke;"> | <div style="clear:both;margin:1.0em 0;background:whitesmoke;"> | ||
{{Collapsible option |statename=optional}} | {{Collapsible option |statename=optional}} | ||
Revision as of 18:47, 16 November 2014
| 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. |
{{Collapsible option}} provides a standardised message for transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter Template:Plaincode.
It may be used on either the template page itself (wrapped within <noinclude>...</noinclude> tags) or on the template's {{documentation subpage}}.
Contents
Indicating optional use of state name
The Template:Plaincode parameter used to manage collapsible templates need not always be named explicitly, i.e. Template:Plaincode can be the same as Template:Plaincode. 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):
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}}
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.
|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 ("Template:Padlr"), 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