Difference between revisions of "Template:Collapsible option/doc"
imported>Sardanaphalus m (→nobase: slight rephrasing) |
imported>Sardanaphalus (a rephrasing, some formatting) |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | <!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE----> | ||
| − | |||
| − | It may be used on either the template page itself | + | {{tl|Collapsible option}} provides a standardised message for [[Wikipedia:Transclusion|transclusion]] on the pages of collapsible templates whose collapsibility may be managed by the parameter {{plaincode|state}}. |
| + | |||
| + | It may be used on either the template page itself (wrapped within {{tag|noinclude}} tags) or on the template's {{tl|documentation subpage}}. | ||
===Indicating optional use of ''state'' name=== | ===Indicating optional use of ''state'' name=== | ||
| − | The | + | 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: |
<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}} | ||
</div> | </div> | ||
| − | <div style="font-size:95%;line-height:1.4em;">(This possibility is enabled | + | <div style="font-size:95%;line-height:1.4em;">(This possibility is enabled by including {{plaincode|<nowiki>{{{1|}}}</nowiki>}} as part of a collapsible template's {{plaincode|state}} parameter{{spndash}}for instance, as {{plaincode|{{nowrap|<nowiki>| state =</nowiki>}} <nowiki>{{{state|{{{1|}}}}}}</nowiki>}} or {{plaincode|{{nowrap|<nowiki>| state =</nowiki>}} <nowiki>{{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki>}}, etc. If, however, the template includes collapsible sections within itself (e.g. {{tl|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 {{para<!--|plain-->|state}} should be retained.)</div> |
===Changing the default state reported=== | ===Changing the default state reported=== | ||
| − | To change the default state {{ | + | To change the default state <nowiki>{{Collapsible option}}</nowiki> reports in its fourth bullet-point, add the parameter {{para<!--|plain-->|default|collapsed}} or {{para<!--|plain-->|default|expanded}} accordingly; or, to restore the autocollapse report, remove any {{para<!--|plain-->|default}} included when <nowiki>{{Collapsible option}}</nowiki> is used. |
===''nobase''=== | ===''nobase''=== | ||
| − | If the template name given to {{ | + | If the template name given to <nowiki>{{Collapsible option}}</nowiki> includes a (forward-)slash character ("{{padlr|/}}"), the parameter {{para<!--|plain-->|nobase}} (set to "on", "true", etc) will need to be added so that the name is displayed correctly (i.e. so that {{wikivar|PAGENAME}} rather than the default {{wikivar|BASEPAGENAME}} is used to display it). |
== See also == | == See also == | ||
Revision as of 11:43, 26 October 2014
| 40px | 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
TheTemplate:Plaincodeparameter 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:
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 fourth bullet-point, add the parameter |default=collapsed or |default=expanded accordingly; or, to restore the autocollapse report, remove any |default= included when {{Collapsible option}} is used.
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