Difference between revisions of "Template:Collapsible lists option"

From blackwiki
Jump to navigation Jump to search
imported>Sardanaphalus
(restricted bold to the key list of names, layout simplification, some rephrasing)
imported>Bsherr
(replacing PAGENAMEBASE with BASEPAGENAME)
 
(61 intermediate revisions by 13 users not shown)
Line 1: Line 1:
* This template includes {{tl|collapsible list}}s.
+
<div style="padding-right:3.6em<!--i.e. around three times Wikipedia's standard indent width, to keep the following away from e.g. template/s on righthand side of page-->;">
: By default, all lists have been set to be <!--
+
This template includes collapsible lists.
  -->{{#ifeq:{{{expanded<includeonly>|</includeonly>}}}|all
 
      | shown.
 
      | hidden. <!----To show all lists:----> To have all lists shown,
 
:: use <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}expanded=all{{))}}</code>
 
:: (or, if enabled, <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}all{{))}}</code>, i.e. without the "expanded=").
 
      }}
 
  
  <!------------- To show a particular list --------------->
+
<!------------ (to show all lists) -------------->
: To have one particular list shown while the others remain hidden, use <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}expanded=''listname''}}</code> (or, if enabled, <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}''listname''}}</code>&nbsp;),
+
: {{Unbulleted list
: where ''listname'' is one of the following:
+
  |style=padding-bottom:0.3em; |list_style=line-height:1.5em;
:: <code style="font-size:110%;font-weight:bold;">{{{listnames<includeonly>|{{color|red|''Required parameter "listnames" missing!''}}</includeonly>}}}</code>
+
  | 1 = {{blue|•}} To set it to display all lists when it appears (i.e. all lists expanded), use:
: (do not include any quotemarks).
+
  | 2 = <span class="nowrap">{{pad|1.2em}}<code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}expanded{{=}}all}}</code></span> or, if enabled, <span class="nowrap"><code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}all}}</code></span>{{spaces|2}}(i.e. omitting "<code>expanded{{=}}</code>").
 +
  }}
  
  <!---------- If an example has been included ------------>
+
<!------------ (to show one list) --------------->
{{#if:{{{example<includeonly>|</includeonly>}}} |
+
: {{Unbulleted list
: <noinclude>{{resize|90%|[''optional example:'']&nbsp;}}</noinclude> For example, <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}expanded={{{example}}}{{))}}</code> (or, if enabled, <code class="nowrap">{{((}}<noinclude>''Template name''</noinclude><includeonly>{{PAGENAME}}</includeonly> {{!}}{{{example}}}{{))}}</code>&nbsp;).
+
  |style=padding-bottom:0.3em; |list_style=line-height:1.5em;
}}<noinclude>
+
  | 1 = {{blue|•}} To set it to display one particular list while keeping the remainder collapsed (i.e. hidden apart from their headings), use:
 +
  | 2 = <span class="nowrap">{{pad|1.2em}}<code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}expanded{{=}}''listname''}}</code></span> or, if enabled, <span class="nowrap"><code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}''listname''}}</code></span>
 +
  | 3 = …where ''listname'' is one of the following (do not include any quotemarks):
 +
  |item4_style=;padding:0.2em 0 0.3em 1.4em;
 +
  | 4 = <kbd style="border: none; background: transparent;">{{{listnames<includeonly>|{{color|red|''Required parameter "listnames" missing!''}}</includeonly>}}} </kbd>
 +
  | 5 = {{#if:{{{example<includeonly>|</includeonly>}}}
 +
          <!--------(optional example)--------->
 +
          |   <noinclude>{{small|[''optional:''{{thinsp}}]}}<br /></noinclude><!--
 +
          -->For example, <span class="nowrap"><code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}expanded{{=}}{{{example}}}}}</code></span> or, if enabled, <span class="nowrap"><code>{{braces|{{{template_name|<includeonly>{{</includeonly>BASEPAGENAME<includeonly>}}</includeonly>}}} {{!}}{{{example}}}}}</code></span>
 +
  }}    }}<!--
  
{{documentation}}
+
<!------------ (optional default) --------------->
<!-- Please add this template's categories to the /doc subpage - thanks! -->
+
{{#if:{{{default<includeonly>|</includeonly>}}} |
</noinclude>
+
* {{#ifeq:{{{default}}}|all  |All lists have
 +
  |  <noinclude>{{small|[''optional:''{{thinsp}}]}}&nbsp; [All lists have]{{\}}[The list named '''''default''''' has]</noinclude><!--
 +
    --><includeonly>The list named '''<code>{{{default}}}</code>''' has</includeonly>}} been set to be shown when the template appears.
 +
}}
 +
</div><noinclude>{{Documentation}}</noinclude>

Latest revision as of 00:22, 28 February 2019

This template includes collapsible lists.

  • To set it to display all lists when it appears (i.e. all lists expanded), use:
  •  {{BASEPAGENAME |expanded=all}} or, if enabled, {{BASEPAGENAME |all}}  (i.e. omitting "expanded=").
  • To set it to display one particular list while keeping the remainder collapsed (i.e. hidden apart from their headings), use:
  •  {{BASEPAGENAME |expanded=listname}} or, if enabled, {{BASEPAGENAME |listname}}
  • …where listname is one of the following (do not include any quotemarks):
  • {{{listnames}}}
  • [optional:Template:Thinsp]
    For example, {{BASEPAGENAME |expanded={{{example}}}}} or, if enabled, {{BASEPAGENAME |{{{example}}}}}
  • [optional:Template:Thinsp]  [All lists have] / [The list named default has] been set to be shown when the template appears.
Template documentation[view] [edit] [history] [purge]
  • When this template is transcluded, the texts within square brackets will either not appear or be replaced accordingly.

Usage

{{Collapsible lists option
| expandedname =  <!--(see below)-->
| listnames =
| example =       <!--(one of the listnames)-->
| default =       <!--("all" or a listname, if either set to be shown)-->
}}

Parameters expandedname, example and default are optional. If the template featuring the collapsible lists already makes use of its first unnamed parameter – see, for example, {{Labor}} – use |expandedname=required with {{Collapsible lists option}} (i.e. {{Collapsible lists option |expandedname=required |…}}) to suppress the "or, if enabled, …" portions of the text above.

See also