Difference between revisions of "Template:Collapsible option/doc"

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
m (replaced <tt>, updated commented instructions)
imported>Sardanaphalus
(update ("nobase"), braces/plaincode/nowiki)
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---->
{{tlf|Collapsible option}} provides a standardised message for [[Wikipedia:Transclusion|transclusion]] on template pages whose templates include a ''state'' parameter through which their collapsibility may be managed.
+
{{tl|Collapsible option}} provides a standardised message for [[Wikipedia:Transclusion|transclusion]] on template pages whose templates include a ''state'' parameter through which their collapsibility may be managed.
  
It may be used on either the template page itself, wrapped within <code><nowiki><noinclude>...</noinclude></nowiki></code> tags, or on the template's {{tl|documentation subpage}}.
+
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 ''state'' parameter used to manage collapsible templates need not always be named explicitly, i.e. <code>{{braces|''Template name''&nbsp;{{!}}''state''}}</code> can be the same as <code>{{braces|''Template name''&nbsp;{{para|state|''state''}}}}</code>. To indicate this in the {{tlf|Collapsible option}} message, add the parameter {{para|statename|optional}}. This modifies the message so that it reads:
+
The ''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&#61;''state''}}}}. To indicate this in the {{braces|Collapsible option}} message, add the parameter {{para|statename|optional}}. This modifies the message so that it reads:
 
<div style="clear:both;background:whitesmoke;">
 
<div style="clear:both;background:whitesmoke;">
 
{{Collapsible option |statename=optional}}
 
{{Collapsible option |statename=optional}}
 
</div>
 
</div>
<div style="font-size:95%;padding-top:0.5em;line-height:1.4em;">(&nbsp;This possibility is enabled in a collapsible template by including <code><nowiki>{{{1|</nowiki>}}}</code> as part of its ''state'' parameter, e.g. as <code>{{nowrap|{{!}} state {{=}}}} <nowiki>{{{state|{{{1|}}}}}}</nowiki></code>&nbsp; or &nbsp;<code>{{nowrap|{{!}} state {{=}}}} <nowiki>{{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki></code>, etc. If, however, the template features 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, expanded, etc. The need to use "{{para|state}}" in these instances should, therefore, be retained.&nbsp;)</div>
+
<div style="font-size:95%;padding-top:0.5em;line-height:1.4em;">(This possibility is enabled in a collapsible template by including {{plaincode|<nowiki>{{{1|}}}</nowiki>}} as part of its ''state'' parameter, e.g. 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 features 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, expanded, etc. The need to use {{para|state}} in these instances should, therefore, be retained.)</div>
  
 
===Changing the default state reported===
 
===Changing the default state reported===
To change the default state {{tlf|Collapsible option}} reports in its fourth bullet-point, add the parameter {{para|default|collapsed}}&nbsp; or {{para|default|expanded}}&nbsp; accordingly, or, to restore the autocollapse report, remove any {{para|default}} included when {{tlf|Collapsible option}} is used.
+
To change the default state {{braces|Collapsible option}} reports in its fourth bullet-point, add the parameter {{para|default|collapsed}} or {{para|default|expanded}} accordingly; or, to restore the autocollapse report, remove any {{para|default}} included when {{braces|Collapsible option}} is used.
 +
 
 +
===''nobase''===
 +
If the template name given to {{braces|Collapsible option}} includes a (forward-)slash character ("{{padlr|/}}"), the parameter {{para|nobase}} (set to "on", "true", etc) will need to be added so that the name is displayed correctly (via {{wikivar|PAGENAME}} rather than the default {{wikivar|BASEPAGENAME}}).
  
 
== See also ==
 
== See also ==
Line 20: Line 23:
 
* [[Help:Collapsing]]
 
* [[Help:Collapsing]]
  
<includeonly>
+
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
| <!----CATEGORIES BELOW THIS LINE, PLEASE:---->
<!----CATEGORIES BELOW THIS LINE, PLEASE:---->
 
 
[[Category:Wikipedia metatemplates]]
 
[[Category:Wikipedia metatemplates]]
  
 
[[es:Plantilla:Opción plegable]]
 
[[es:Plantilla:Opción plegable]]
}}
+
}}</includeonly>
</includeonly>
 

Revision as of 14:34, 15 October 2014

{{Collapsible option}} provides a standardised message for transclusion on template pages whose templates include a state parameter through which their collapsibility may be managed.

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: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}}
    • shows the template collapsed to the title bar if there is a {{navbar}}, a {{sidebar}}, or some other table on the page with the collapsible attribute
    • shows the template in its expanded state if there are no other collapsible items on the page

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.

(This possibility is enabled in a collapsible template by including Template:Plaincode as part of its state parameter, e.g. as Template:Plaincode or Template:Plaincode, etc. If, however, the template features collapsible sections within itself (e.g. {{Navbox with collapsible groups}}), then enabling this possibility may introduce ambiguity as regards what is to be collapsed, expanded, etc. The need to use |state= in these instances should, therefore, 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 (via Template:Wikivar rather than the default Template:Wikivar).

See also