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

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
(category)
imported>Sardanaphalus
(→‎Changing the default state reported: correction, split sentence)
Line 14: Line 14:
  
 
===Changing the default state reported===
 
===Changing the default state reported===
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.
+
To change the default state <nowiki>{{Collapsible option}}</nowiki> reports in its second bullet-point, add the parameter {{para<!--|plain-->|default|collapsed}} or {{para<!--|plain-->|default|expanded}} accordingly. To restore the default report, remove any {{para<!--|plain-->|default}} previously included.
  
 
===''nobase''===
 
===''nobase''===

Revision as of 12:02, 26 October 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

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 (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:Spndashfor 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: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