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

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
(whitesmoke)
imported>Sardanaphalus
(updates, including |default= and category handling)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
The <code><nowiki>{{collapsible option}}</nowiki></code> template gives a standardised message for [[Wikipedia:Transclusion|transclusion]] on template pages whose templates include a ''state'' parameter (through which their collapsibility may be managed).
+
{{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.
  
It may be used on either the template page itself (wrapped within <tt><nowiki><noinclude></noinclude></nowiki></tt> tags), or on the template's {{tl|documentation subpage}}.
+
It may be used on either the template page itself, wrapped within <tt><nowiki><noinclude>...</noinclude></nowiki></tt> tags, or on the template's {{tl|documentation subpage}}.
  
 
===Indicating optional use of ''state'' name===
 
===Indicating optional use of ''state'' name===
If, in a template where {{tlc|collapsible option}} has been transcluded, that template's ''state'' parameter has been enabled such that it need not be named when the template is called{{spaced ndash}}i.e., the ''state'' parameter includes <code><nowiki>{{{1| }}}</nowiki></code>, e.g.:
+
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:
: <code><nowiki>|state = {{{state|{{{1|}}}}}}</nowiki></code>
+
<div style="clear:both;background:whitesmoke;">
 +
{{Collapsible option |statename=optional}}
 +
</div>
 +
<div style="font-size:95%;">
 +
(&nbsp;This possibility is enabled in a collapsible template by including <code><nowiki>{{{1|</nowiki>&nbsp;}}}</code> as part of its ''state'' parameter. For example:
 +
: <code><nowiki>| state = {{{state|{{{1|}}}}}}</nowiki></code>
 
: or
 
: or
: <code><nowiki>|state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki></code>
+
: <code><nowiki>| state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}</nowiki></code>
: etc
+
: and so on.
then...
+
If, however, the template features collapsible sections within itself (e.g. {{tl|Navbox with collapsible groups}}) then implementing the above 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;)
: <code><nowiki>{{collapsible option |statename=optional}}</nowiki></code>
 
...removes the instances of {{para|state}} from the {{tlc|collapsible option}} message, meaning it will appear as:
 
<div style="clear:both;background:whitesmoke;">
 
{{collapsible option |statename=optional}}
 
 
</div>
 
</div>
  
===Changing default===
+
===Changing the default state reported===
To change the ''state'' default from "autocollapse", use either "collapsed" or "expanded", as in the following:
+
To change the default state {{tlf|Collapsible option}} reports in its fourth bullet-point, add the parameter {{para|default|collapsed}}&thinsp; or &thinsp;{{para|default|expanded}} accordingly, or, to restore the autocollapse report, remove any {{para|default}}.
{{clear}}
 
: <code><nowiki>{{collapsible option |state=collapsed}}</nowiki></code>
 
This will appear as:
 
<div style="clear:both;background:whitesmoke;">
 
{{collapsible option |state=collapsed}}
 
</div>
 
 
 
 
 
 
== See also ==
 
== See also ==
Line 32: Line 27:
  
 
<includeonly>
 
<includeonly>
[[Category:Wikipedia metatemplates]]
+
{{#ifeq:{{SUBPAGENAME}}|sandbox | |[[Category:Wikipedia metatemplates]]}}
  
 
[[es:Plantilla:Opción plegable]]
 
[[es:Plantilla:Opción plegable]]
 
</includeonly>
 
</includeonly>

Revision as of 09:48, 14 May 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-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:

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 {{{1| }}} as part of its state parameter. For example:

| state = {{{state|{{{1|}}}}}}
or
| state = {{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}
and so on.

If, however, the template features collapsible sections within itself (e.g. {{Navbox with collapsible groups}}) then implementing the above 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=.

See also