Difference between revisions of "Template:Sidebar with collapsible lists/doc"

From EVE University Wiki
Jump to: navigation, search
m (Update dependencies.)
m (Update dependencies. Update doc)
Line 11: Line 11:
 
:: {{T|SistersOfEVEEpicArcNav}}
 
:: {{T|SistersOfEVEEpicArcNav}}
 
:: {{T|CaldariEpicArcNav}}
 
:: {{T|CaldariEpicArcNav}}
 +
:: {{T|MinmatarEpicArcNav}}
  
 
; Syntax
 
; Syntax
Line 31: Line 32:
 
| above =  
 
| above =  
  
−
| expanded =
+
| expanded =
 +
 
 +
| contentclass=
 +
| listclas=  
  
 
| heading1 =  
 
| heading1 =  
Line 44: Line 48:
  
 
| heading3 =  
 
| heading3 =  
−
| list3name  =
+
| content3 =  
−
| list3title =
 
−
| list3      =  
 
  
−
<!-- More heading<x>, list<x> blocks as required up to a maximum of 35 -->
+
<!-- More heading<x>, list<x>/content<x> blocks as required up to a maximum of 35 -->
  
 
| below =  
 
| below =  
Line 55: Line 57:
 
}}
 
}}
 
</pre>
 
</pre>
 +
 +
: This template uses mostly the same parameter set as {{Tl|Sidebar}} see there for the shared parameters.
  
 
:; Parameters (Data)
 
:; Parameters (Data)
−
: This template uses mostly the same parameter set as {{Tl|Sidebar}} see there for the shared parameters.
 
 
:; expanded : Used to identify which list is to be shown initially expanded. Use the <code>list''<x>''name</code> of the wanted list or use <code>all</code> to show all lists expanded.
 
:; expanded : Used to identify which list is to be shown initially expanded. Use the <code>list''<x>''name</code> of the wanted list or use <code>all</code> to show all lists expanded.
 
:: This parameter should normally not be hard coded but being offered as a parameter from the template call.
 
:: This parameter should normally not be hard coded but being offered as a parameter from the template call.
Line 63: Line 66:
 
:; list''<x>''name : ''x'' is 1 till 35 - Target of the <code>expanded</code> parameter. A list without this parameter or empty can not be initially expanded.
 
:; list''<x>''name : ''x'' is 1 till 35 - Target of the <code>expanded</code> parameter. A list without this parameter or empty can not be initially expanded.
 
:; list''<x>''title : ''x'' is 1 till 35 - Text in the non-collapsible part, defaults to "List". Use &amp;nbsp; to leave empty.
 
:; list''<x>''title : ''x'' is 1 till 35 - Text in the non-collapsible part, defaults to "List". Use &amp;nbsp; to leave empty.
−
:; list''<x>'' : ''x'' is 1 till 35 - The contents of the collapsible part of the list.
+
:; list''<x>'' : ''x'' is 1 till 35 - The contents of the collapsible part of the list. The list is injected into {{Tl|Sidebar}} content''<x>''.
  
−
:: If one or more lists should always be expanded the Sidebar <code>content''<x>''</code> can be used.
+
:: If one or more lists should always be expanded the <code>content''<x>''</code> can be used.
 
:: If both <code>list''<x>''</code> and <code>content''<x>''</code> are used list has the preference.
 
:: If both <code>list''<x>''</code> and <code>content''<x>''</code> are used list has the preference.
 +
 +
:; Parameters (Format)
 +
::; listclass : Name of the CSS class(es) to be applied to all list''<x>'' parameters. i.e. <code>plainlist</code> to achieve {{Tl|Plainlist}} effect on the list.
  
 
; Sample
 
; Sample
−
: Using the following as the content of a template called example, calling <nowiki>{{example}}</nowiki> has all lists collapsed. Using <nowiki>{{example|all}}</nowiki> shows all list expanded and <nowiki>{{example|two}}</nowiki> only expands list 2.
+
: (1) Using the following as the content of a template called example, calling <nowiki>{{example}}</nowiki> has all lists collapsed. Using <nowiki>{{example|all}}</nowiki> shows all list expanded and <nowiki>{{example|two}}</nowiki> only expands list 2.
 +
{{Sidebar with collapsible lists
 +
| topimage = [[File:Agent.png]]
 +
 
 +
| title = Sidebar title
 +
 
 +
| expand = {{{1|}}}
 +
| contentclass= plainlist
 +
 
 +
| heading1 = Heading 1
 +
| list1name  = one
 +
| list1title = First list
 +
| list1      =
 +
* link 1-1
 +
* link 1-2
 +
* link 1-3
 +
 
 +
| heading2 = Heading 2
 +
| list2name  = two
 +
| list2title =
 +
| list2      =
 +
* link 2-1
 +
* link 2-2
 +
* link 2-3
 +
 
 +
| heading3 = Heading 3
 +
| list3name  = three
 +
| list3title = &nbsp;
 +
| list3      =
 +
* link 3-1
 +
* link 3-2
 +
* link 3-3
 +
 
 +
| heading4 = Heading 4
 +
| content4 =
 +
* link 4-1
 +
* link 4-2
 +
* link 4-3
 +
 
 +
| navbar = off
 +
 
 +
}}
 +
<pre>{{Sidebar with collapsible lists
 +
| topimage = [[File:Agent.png]]
 +
 
 +
| title = Sidebar title
 +
 
 +
| expand = <nowiki>{{{1|}}}</nowiki>
 +
| contentclass= plainlist
 +
 
 +
| heading1 = Heading 1
 +
| list1name  = one
 +
| list1title = First list
 +
| list1      =
 +
* link 1-1
 +
* link 1-2
 +
* link 1-3
 +
 
 +
| heading2 = Heading 2
 +
| list2name  = two
 +
| list2title =
 +
| list2      =
 +
* link 2-1
 +
* link 2-2
 +
* link 2-3
 +
 
 +
| heading3 = Heading 3
 +
| list3name  = three
 +
| list3title = &nbsp;
 +
| list3      =
 +
* link 3-1
 +
* link 3-2
 +
* link 3-3
 +
 
 +
| heading4 = Heading 4
 +
| content4 =
 +
* link 4-1
 +
* link 4-2
 +
* link 4-3
 +
 
 +
| navbar = off
 +
 
 +
}}
 +
</pre>
 +
 
 +
 
 +
: (2) Using <code>listclass</code> instead of <code>contentclass</code> causes the class to only be applied to the list parameter. The class(es) in <code>listclass</code> override the classes in<code>contentclass</code> following the normal rules for CSS.
 
{{Sidebar with collapsible lists
 
{{Sidebar with collapsible lists
 
| topimage = [[File:Agent.png]]
 
| topimage = [[File:Agent.png]]
Line 76: Line 168:
  
 
| expand = {{{1|}}}
 
| expand = {{{1|}}}
 +
| listclass = plainlist
  
 
| heading1 = Heading 1
 
| heading1 = Heading 1
Line 81: Line 174:
 
| list1title = First list
 
| list1title = First list
 
| list1      =  
 
| list1      =  
−
link 1-1<br>
+
* link 1-1
−
link 1-2<br>
+
* link 1-2
−
link 1-3<br>
+
* link 1-3
  
 
| heading2 = Heading 2
 
| heading2 = Heading 2
Line 89: Line 182:
 
| list2title =  
 
| list2title =  
 
| list2      =  
 
| list2      =  
−
link 2-1<br>
+
* link 2-1
−
link 2-2<br>
+
* link 2-2
−
link 2-3<br>
+
* link 2-3
  
 
| heading3 = Heading 3
 
| heading3 = Heading 3
Line 97: Line 190:
 
| list3title = &nbsp;
 
| list3title = &nbsp;
 
| list3      =  
 
| list3      =  
−
link 3-1<br>
+
* link 3-1
−
link 3-2<br>
+
* link 3-2
−
link 23-3<br>
+
* link 3-3
  
 
| heading4 = Heading 4
 
| heading4 = Heading 4
 
| content4 =  
 
| content4 =  
−
link 4-1<br>
+
* link 4-1
−
link 4-2<br>
+
* link 4-2
−
link 4-3<br>
+
* link 4-3
  
 
| navbar = off
 
| navbar = off
Line 121: Line 214:
 
| list1title = First list
 
| list1title = First list
 
| list1      =  
 
| list1      =  
−
link 1-1<br>
+
* link 1-1
−
link 1-2<br>
+
* link 1-2
−
link 1-3<br>
+
* link 1-3
  
 
| heading2 = Heading 2
 
| heading2 = Heading 2
Line 129: Line 222:
 
| list2title =  
 
| list2title =  
 
| list2      =  
 
| list2      =  
−
link 2-1<br>
+
* link 2-1
−
link 2-2<br>
+
* link 2-2
−
link 2-3<br>
+
* link 2-3
  
 
| heading3 = Heading 3
 
| heading3 = Heading 3
Line 137: Line 230:
 
| list3title = &nbsp;
 
| list3title = &nbsp;
 
| list3      =  
 
| list3      =  
−
link 3-1<br>
+
* link 3-1
−
link 3-2<br>
+
* link 3-2
−
link 23-3<br>
+
* link 3-3
  
 
| heading4 = Heading 4
 
| heading4 = Heading 4
 
| content4 =  
 
| content4 =  
−
link 4-1<br>
+
* link 4-1
−
link 4-2<br>
+
* link 4-2
−
link 4-3<br>
+
* link 4-3
  
 
| navbar = off
 
| navbar = off

Revision as of 12:43, 31 July 2023

Description
This template is a metatemplate for the creation of sidebar templates with collapsible lists, i.e. boxes that are vertically-aligned navigational templates.
For the non-collapsible version see {{Sidebar}}.
This template is converted from the last non-lua version of Wikipedia Sidebar with collapsible lists
Dependencies
Uses
{{Sidebar}}
{{Sidebar with collapsible lists/row}}
Used by
{{SistersOfEVEEpicArcNav}}
{{CaldariEpicArcNav}}
{{MinmatarEpicArcNav}}
Syntax
For UnuWiki navigational sidebar with collapsible lists
The UniWiki navigational sidebar with collapsible lists uses a subset of the available parameters and only the parameters used are documented.
{{Sidebar
| name = {{subst:PAGENAME}}

| topimage = 
| topcaption = 

| pretitle = 

| title = 

| image = 
| caption = 

| above = 

| expanded = 

| contentclass= 
| listclas= 

| heading1 = 
| list1name  = 
| list1title = 
| list1      = 

| heading2 = 
| list2name  = 
| list2title = 
| list2      = 

| heading3 = 
| content3 = 

<!-- More heading<x>, list<x>/content<x> blocks as required up to a maximum of 35 -->

| below = 
| navbar = off

}}
This template uses mostly the same parameter set as {{Sidebar}} see there for the shared parameters.
Parameters (Data)
expanded
Used to identify which list is to be shown initially expanded. Use the list<x>name of the wanted list or use all to show all lists expanded.
This parameter should normally not be hard coded but being offered as a parameter from the template call.
Without this parameter all lists show as collapsed
list<x>name
x is 1 till 35 - Target of the expanded parameter. A list without this parameter or empty can not be initially expanded.
list<x>title
x is 1 till 35 - Text in the non-collapsible part, defaults to "List". Use &nbsp; to leave empty.
list<x>
x is 1 till 35 - The contents of the collapsible part of the list. The list is injected into {{Sidebar}} content<x>.
If one or more lists should always be expanded the content<x> can be used.
If both list<x> and content<x> are used list has the preference.
Parameters (Format)
listclass
Name of the CSS class(es) to be applied to all list<x> parameters. i.e. plainlist to achieve {{Plainlist}} effect on the list.
Sample
(1) Using the following as the content of a template called example, calling {{example}} has all lists collapsed. Using {{example|all}} shows all list expanded and {{example|two}} only expands list 2.
Agent.png
Sidebar title
Heading 1
First list
  • link 1-1
  • link 1-2
  • link 1-3
Heading 2
List
  • link 2-1
  • link 2-2
  • link 2-3
Heading 3
 
  • link 3-1
  • link 3-2
  • link 3-3
Heading 4
  • link 4-1
  • link 4-2
  • link 4-3
 
{{Sidebar with collapsible lists
| topimage = [[File:Agent.png]]

| title = Sidebar title

| expand = {{{1|}}}
| contentclass= plainlist

| heading1 = Heading 1
| list1name  = one
| list1title = First list
| list1      = 
* link 1-1
* link 1-2
* link 1-3

| heading2 = Heading 2
| list2name  = two
| list2title = 
| list2      = 
* link 2-1
* link 2-2
* link 2-3

| heading3 = Heading 3
| list3name  = three
| list3title =  
| list3      = 
* link 3-1
* link 3-2
* link 3-3

| heading4 = Heading 4
| content4 = 
* link 4-1
* link 4-2
* link 4-3

| navbar = off

}}


(2) Using listclass instead of contentclass causes the class to only be applied to the list parameter. The class(es) in listclass override the classes incontentclass following the normal rules for CSS.
Agent.png
Sidebar title
Heading 1
First list
  • link 1-1
  • link 1-2
  • link 1-3
Heading 2
List
  • link 2-1
  • link 2-2
  • link 2-3
Heading 3
 
  • link 3-1
  • link 3-2
  • link 3-3
Heading 4
  • link 4-1
  • link 4-2
  • link 4-3
 
{{Sidebar with collapsible lists
| topimage = [[File:Agent.png]]

| title = Sidebar title

| expand = {{{1|}}}

| heading1 = Heading 1
| list1name  = one
| list1title = First list
| list1      = 
* link 1-1
* link 1-2
* link 1-3

| heading2 = Heading 2
| list2name  = two
| list2title = 
| list2      = 
* link 2-1
* link 2-2
* link 2-3

| heading3 = Heading 3
| list3name  = three
| list3title =  
| list3      = 
* link 3-1
* link 3-2
* link 3-3

| heading4 = Heading 4
| content4 = 
* link 4-1
* link 4-2
* link 4-3

| navbar = off

}}
Note
This documentation does not include all possible parameters. Only the parameters for use in the UniWiki navigational sidebar are documented. Reason: lack of time, seeing no use for them now. And being plain lazy -- Evon R'al (talk) 18:35, 23 July 2023 (UTC)
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:Sidebar_with_collapsible_lists/doc&oldid=206417"