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

From blackwiki
Jump to navigation Jump to search
imported>Vanisaac
m (clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
imported>Bsherr
m (replacing Template:Tld with Template:Tlc, plus general and typo fixes as found)
 
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!-- Categories go where indicated at the bottom of this page, please; interwikis go to Wikidata (see also: [[Wikipedia:Wikidata]]). -->
+
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
 
{{High-risk| approximately 108000 }}
 
{{High-risk| approximately 108000 }}
 
{{tlx|Collapsible option}} provides a standardised message for [[Wikipedia:Transclusion|transclusion]] on the pages of collapsible templates whose collapsibility may be managed by the parameter {{para|state}}.
 
{{tlx|Collapsible option}} provides a standardised message for [[Wikipedia:Transclusion|transclusion]] on the pages of collapsible templates whose collapsibility may be managed by the parameter {{para|state}}.
Line 18: Line 18:
 
If, however, the template includes collapsible sections within itself (e.g. {{tlx|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|state}} should be retained.
 
If, however, the template includes collapsible sections within itself (e.g. {{tlx|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|state}} should be retained.
  
===Changing the default state===
+
===Changing the default state===
 
To change the default state {{tnull|Collapsible option}} uses, add the parameter {{para|default|collapsed}} or {{para|default|expanded}} accordingly. To restore the default, remove any {{para|default}} previously included.
 
To change the default state {{tnull|Collapsible option}} uses, add the parameter {{para|default|collapsed}} or {{para|default|expanded}} accordingly. To restore the default, remove any {{para|default}} previously included.
  
Line 24: Line 24:
  
 
===Slashes and the {{samp|nobase}} parameter ===
 
===Slashes and the {{samp|nobase}} parameter ===
If the template name given to {{tnull|Collapsible option}}</nowiki> includes a forward-slash (virgule) character – <kbd>/</kbd> – then the parameter {{para|nobase}} (set to {{kbd|on}}, {{kbd|true}}, etc.) will need to be added so that the name is displayed correctly (i.e., so that {{tld|PAGENAME}} rather than the default {{tld|BASEPAGENAME}} is used to display it).
+
If the template name given to {{tnull|Collapsible option}}</nowiki> includes a forward-slash (virgule) character – <kbd>/</kbd> – then the parameter {{para|nobase}} (set to {{kbd|on}}, {{kbd|true}}, etc.) will need to be added so that the name is displayed correctly (i.e., so that {{tlc|PAGENAME}} rather than the default {{tlc|BASEPAGENAME}} is used to display it).
  
 
== See also ==
 
== See also ==
Line 33: Line 33:
  
 
<includeonly>{{Sandbox other||
 
<includeonly>{{Sandbox other||
<!-- Categories go below this line, please; interwikis go to Wikidata, thank you! -->
+
<!-- Categories below this line; interwikis at Wikidata -->
 
[[Category:Documentation shared content templates]]
 
[[Category:Documentation shared content templates]]
 
[[Category:Wikipedia metatemplates]]
 
[[Category:Wikipedia metatemplates]]
  
 
}}</includeonly>
 
}}</includeonly>

Latest revision as of 22:40, 9 August 2020

{{Collapsible option}} provides a standardised message for transclusion on the pages of collapsible templates whose collapsibility may be managed by the parameter |state=.

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}}, if the template is coded that way. 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:

  • {{{1|}}} as part of a collapsible template's |state= parameterTemplate:Spaced ndashfor instance, as |state={{{state|{{{1|}}}}}} or |state={{{state|{{{1|<noinclude>expanded</noinclude>}}}}}}, etc.
  • <noinclude>,<includeonly>as part of a collapsible template's state argumentTemplate:Spaced ndashfor instance, as |state={{{state<includeonly>|collapsed</includeonly>}}}

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

To change the default state {{Collapsible option}} uses, add the parameter |default=collapsed or |default=expanded accordingly. To restore the default, remove any |default= previously included.

The |default=collapsed option must not be used in main article content in mainspace, e.g. to hide tables of information, or to cram extraneous details into infoboxes. (For more information, see Script error: No such module "Section link"..) This option is permissible in navboxes, which are not part of the article content per se.

Slashes and the nobase parameter

If the template name given to {{Collapsible option}}</nowiki> includes a forward-slash (virgule) character – / – then the parameter |nobase= (set to on, true, etc.) will need to be added so that the name is displayed correctly (i.e., so that {{PAGENAME}} rather than the default {{BASEPAGENAME}} is used to display it).

See also