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

From blackwiki
Jump to navigation Jump to search
imported>GermanJoe
m (→‎Indicating optional use of state name: fix - whitespace in doc aswell (see talkpage))
imported>Jdaloner
m (Updated/adjusted usage of a couple templates.)
Line 11: Line 11:
 
{{Collapsible option |statename=optional}}
 
{{Collapsible option |statename=optional}}
 
</div>
 
</div>
<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>
+
<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{{spaced ndash}}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===
Line 17: Line 17:
  
 
===''nobase''===
 
===''nobase''===
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).
+
If the template name given to <nowiki>{{Collapsible option}}</nowiki> includes a (forward-)slash character ("{{pad left and right|/}}"), 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 ==
Line 23: Line 23:
 
* {{tl|Collapsible sections option}}
 
* {{tl|Collapsible sections option}}
 
* [[Help:Collapsing]]
 
* [[Help:Collapsing]]
 +
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |

Revision as of 02:10, 17 December 2014

{{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}}.

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}}
    • 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 by including Template:Plaincode as part of a collapsible template's Template:Plaincode parameterTemplate:Spaced ndashfor instance, as Template:Plaincode or Template:Plaincode, etc. If, however, the template includes collapsible sections within itself (e.g. {{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 |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:Pad left and right"), 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