Template:Sidebar with collapsible lists/doc

This is a documentation subpage for Template:Sidebar with collapsible lists (see that page for the template itself).
It contains usage information, categories, and other content that is not part of the original template page.

This template is used on approximately 65,000 pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.

File:Handheld devices no.svg

This template does not display in the mobile view of Wikipedia; it is desktop only. Read the documentation for an explanation.

This template uses Lua:

Module:Sidebar

{{Sidebar with collapsible lists}} is a version of {{Sidebar}} which offers collapsible lists in addition to Sidebar's content parameters.

Usage

Template:Generic template demo Parameters with infrequent use omitted.

{{Sidebar with collapsible lists
| name     = {{subst:PAGENAME}}
| pretitle = 
| title    = 
| image    = 
| templatestyles = 
| expanded = {{{expanded|}}}

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

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

<!-- ...... -->

| headingN =         <!-- Template:Sidebar's "headingN" and/or "contentN" parameters (where -->
| contentN =         <!-- N is a number) may be used to include uncollapsible lists/content -->

<!-- ...... -->

| below = 

}}

Parameters

Further information: Template:Sidebar#Parameters

This template takes all {{sidebar}} parameters. In addition:

|list_ntitle=: The displayed title of the collapsible list_n.
|list_n=: The contents of the collapsible list_n.
|list_nclass=: A class can be added to target a specific list either with TemplateStyles or microformats. See Template:Sidebar § Classes.; In the context of TemplateStyles, specific list contents can be targeted like so: .templateclass .listnclass .sidebar-list-title for a specific list title and .templateclass .listnclass .sidebar-list for a specific list.
|expanded= and |list_nname=: |expanded= is used to indicate which (if any) list named |list_nname= is shown expanded when the template is first displayed; see {{Collapsible lists option}}.
|centered list titles=: Set to anything (though |centered list titles=y or |centered list titles=yes are idiomatic) to make the sidebar list titles centered. This works around some not-great behavior in how centered text interacts with the collapsible toggle.

A |list_n= without a |list_ntitle= displays the default title ("List").

Handling long links

Further information: Template:Sidebar#Handling long links

See Template:Sidebar § Handling long links.

TemplateStyles

The classes available for styling, besides those listed in Template:Sidebar § TemplateStyles, are:

.sidebar-collapse: The top-level {{sidebar with collapsible lists}} class.
.sidebar-list: The class is a container when either |list_ntitle= or |list_n= is provided in {{sidebar with collapsible lists}}.
.sidebar-list-title: The class associated with a |list_ntitle=. Every list title will have this class. Use the |centered list titles= to center text instead of adding CSS here.
.sidebar-list-content: The class associated with a |list_n=. Every list content will have this class.

Deprecated parameters

Further information: Template:Sidebar#Deprecated parameters

These parameters are deprecated for the same reason as the style parameters in {{Sidebar}} template.

listtitlestyle and liststyle: These are the equivalent of, respectively, {{Collapsible list}}'s titlestyle and liststyle parameters.
listframestyle: Sets the framestyle (see {{Collapsible list}}) for the lists.
listNframestyle: Sets the framestyle for listN, overriding listframestyle.
listNtitlestyle: Sets the titlestyle for listN, overriding listtitlestyle above.
listNstyle: Sets the liststyle for listN, overriding liststyle above.