Difference between revisions of "Template:Collapsible option"

From All About Ayrshire
Jump to: navigation, search
(Allow changing the default state specified per the documentation)
 
m (1 revision imported)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
'''How to manage this template's initial visibility'''<br />
+
'''{{big|Initial visibility:}}''' currently defaults to '''{{big|{{#switch:{{{default|}}}|collapsed=collapsed|expanded=expanded|autocollapse|#default=autocollapse}}}}'''
−
To manage this template's visibility when it first appears, [[Help:Template#Parameters|add the parameter]]:
 
−
:{{para|state|collapsed}} to show the template in its collapsed state, i.e. hidden apart from its titlebar&nbsp;– e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=collapsed}}</nowiki></code>
 
−
:{{para|state|expanded}} to show the template in its expanded state, i.e. fully visible&nbsp;– e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=expanded}}</nowiki></code>
 
−
:{{para|state|autocollapse}} to show the template in its collapsed state ''but only if'' there is another template of the same type on the page&nbsp;– e.g. <code><nowiki>{{</nowiki><includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly><nowiki> |state=autocollapse}}</nowiki></code>
 
  
−
Unless set otherwise (see the {{para|state}} parameter in the template's code), the template's default state is <code>{{#switch:{{{default|}}}|collapsed=collapsed|expanded=expanded|autocollapse|#default=autocollapse}}</code>.<!--
+
To set this template's initial visibility, the {{para|{{{parameter_name|state}}}}} [[Help:Template#Parameters|parameter]] may be used:
 +
<ul>
 +
<li>{{para|{{{parameter_name|state}}}|collapsed}}: <code><nowiki>{{</nowiki><includeonly>{{</includeonly>{{#if:{{{nobase|}}}| |BASE}}PAGENAME<includeonly>}}</includeonly><nowiki>|</nowiki>{{{parameter_name|state}}}<nowiki>=collapsed}}</nowiki></code> to show the template collapsed, i.e., hidden apart from its title bar</li>
 +
<li>{{para|{{{parameter_name|state}}}|expanded}}: <code><nowiki>{{</nowiki><includeonly>{{</includeonly>{{#if:{{{nobase|}}} | |BASE}}PAGENAME<includeonly>}}</includeonly><nowiki>|</nowiki>{{{parameter_name|state}}}<nowiki>=expanded}}</nowiki></code> to show the template expanded, i.e., fully visible</li>
 +
<li>{{para|{{{parameter_name|state}}}|autocollapse}}: <code><nowiki>{{</nowiki><includeonly>{{</includeonly>{{#if:{{{nobase|}}} | |BASE}}PAGENAME<includeonly>}}</includeonly><nowiki>|</nowiki>{{{parameter_name|state}}}<nowiki>=autocollapse}}</nowiki></code>
 +
<ul>
 +
<li>shows the template collapsed to the title bar if there is a {{tlx|navbar}}, a {{tlx|sidebar}}, or some other table on the page with the collapsible attribute</li>
 +
<li>shows the template in its expanded state if there are no other collapsible items on the page</li>
 +
</ul></li></ul>
 +
If the {{para|{{{parameter_name|state}}}}} parameter in the template on this page is not set, the template's initial visibility is taken from the {{para|default}} parameter in the ''Collapsible option'' template. For the template on this page, that currently evaluates to {{big|'''<code>{{#switch:{{{default|}}}|collapsed=collapsed|expanded=expanded|autocollapse|#default=autocollapse}}</code>'''}}.<!--
 
-->{{#if:{{{align|}}}|
 
-->{{#if:{{{align|}}}|
−
:{{para|align|''value''}} is also available; where ''value'' can be either <code>right</code> or <code>left</code>. The default is <code>center</code>
+
:{{para|align|{{var|value}}}} is also available; where {{var|value}} can be either <code>right</code> or <code>left</code>. The default is {{kbd|center}}.
−
}}{{#if:{{{title-background|}}}|:{{para|title-background|''value''}} is also available; where ''value'' can be either <code>navbox</code> or a <code>color</code>. The default is <code>none</code> and <code>navbox</code> defaults to the default navbox color.
+
}}{{#if:{{{title-background|}}}|:{{para|title-background|{{var|value}}}} is also available; where {{var|value}} can be either {{kbd|navbox}} or a {{kbd|color}}. The default is {{kbd|none}}, and {{{kbd|navbox}} defaults to the default navbox color.
 
}}{{#if:{{{width|}}}|
 
}}{{#if:{{{width|}}}|
−
:{{para|width|''value''}} is also available; where ''value'' can be either <code>N [em/%/px]</code> or <code>auto</code>. The default is <code>100%</code>
+
:{{para|width|{{var|value}}}} is also available; where {{var|value}} can be either {{kbd|{{var|N}} [em/%/px]}} or {{kbd|auto}}. The default is {{kbd|100%}}.
 
}}<!--
 
}}<!--
 
Add {{pp-template}} if template page where this template is transcluded is protected:
 
Add {{pp-template}} if template page where this template is transcluded is protected:
Line 18: Line 23:
 
   }} }}<noinclude>
 
   }} }}<noinclude>
 
{{Documentation}}
 
{{Documentation}}
 +
<!-- Add categories to the /doc subpage, interwikis to Wikidata, not here -->
 
</noinclude>
 
</noinclude>

Latest revision as of 18:14, 27 December 2020

Initial visibility: currently defaults to autocollapse

To set this template's initial visibility, the |state= parameter may be used:

  • |state=collapsed: {{BASEPAGENAME|state=collapsed}} to show the template collapsed, i.e., hidden apart from its title bar
  • |state=expanded: {{BASEPAGENAME|state=expanded}} to show the template expanded, i.e., fully visible
  • |state=autocollapse: {{BASEPAGENAME|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.

Template documentation[create]
Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this template.
Retrieved from "http://igoaddons.eu.org/index.php?title=Template:Collapsible_option&oldid=10883"