Template:Sidebar with collapsible lists/doc

From EVE University Wiki
< Template:Sidebar with collapsible lists
Revision as of 11:58, 7 August 2023 by Evon R'al (talk | contribs) (Update dependencies.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search
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
{{AngelEpicArcNav}}
{{AmarrEpicArcNav}}
{{CaldariEpicArcNav}}
{{GallenteEpicArcNav}}
{{GuristasEpicArcNav}}
{{MinmatarEpicArcNav}}
{{SistersOfEVEEpicArcNav}}
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 = {{{1|}}}

| 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.
{{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.
{{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)