Template:Navbox with collapsible groups/doc
This template produces a navigational template that has groups of relevant articles on a certain topic. All groups are hidden by default. However, with a parameter call, an individual group can be shown that has the other articles in the same group.
Contents
Usage
Please remove the parameters that are left blank. The template currently supports up to 10 groups/lists but more can be added if needed. You should use a minimum of two groups/lists; otherwise, use Template:Navbox instead.
{{Navbox with collapsible groups |name = {{subst:PAGENAME}} |state = |selected = {{{1|}}} |title = |titlestyle = |groupstyle = |image = |group1 = |abbr1 = |list1 = |group2 = |abbr2 = |list2 = ... |group10 = |abbr10 = |list10 = }}
Parameters
This template shares many common parameters with its sister templates Template:Navbox and Template:Navbox with columns. The common parameters are marked with a cross†. Please refer to the documentation of Template:Navbox for more in depth descriptions and examples of those parameters.
Setup parameters
- name†
- The name of the template. The name of this template, for example, is "Navbox with collapsible groups".
- state† [
autocollapse, uncollapsed, collapsed, plain, off
] - The initial state of the show/hide feature. See Template:Navbox for more information.
- state† [
- navbar†
- Possible values are
plain
,off
, and the default value of blank. See Template:Navbox for more information.
- border†
- Possible values are
child
,none
, and the default value of blank. Set tochild
if you wish to use the navbox inside of another navbox; with this option, the child navbox is borderless and fits snuggly inside of its parent navbox. The parent navbox may be the list area of Template:Navbox, the columns of a [[Template:Navbox with columns[[, or a list area of Template:Navbox with collapsible groups. See Template:Navbox for more information and examples.
Basic data parameters
- title†
- The title of the template, displayed centered in the titlebar at the top of the template.
- above†
- Text or other elements to appear above groups/lists.
- image†
- Image to the right of all of the groups/lists.
- imageleft†
- Image to the left of all of the groups/lists.
- below†
- Text or other elements to appear below the groups/lists.
Group/list parameters
- groupn
- The title of each section.
- listn†
- The content/wikilinks that will be shown in the group. Use dots or bullets as separators (see the See also section). A Template:Navbox or Template:Navbox with columns can optionally be used here with its
border = child
parameter set. If this is done, leave the corresponding groupn blank, as the child navbox will already provide the collapsible feature.
- abbrn
- This is the abbreviation of the group. See
selected
parameter below to see how to use this parameter. This parameter is optional, but recommended.
- selected
- If the value of
selected
equals the value ofabbrn
, then listn is uncollapsed and all other lists are collapsed. Ifselected
is left blank, or if it does not match anyabbrn
, then all groups are collapsed. Usually this parameter should be set to {{{1|}}}. Since this template is a base template for others, there has to be a way to pass the group parameter from the article, to the secondary template to this one.
- staten [
autocollapse, uncollapsed, collapsed, plain, off
] - The initial collapsible state of listn. Set to collapsed by default. Overridden to uncollapsed if
selected
equalsabbrn
.
- staten [
- imagen
- An image to appear in the listn content area on the right side.
- imageleftn
- An image to appear in the listn content area on the left side.
Style parameters
- bodystyle†
- CSS style/s to apply to the entire template
- titlestyle†
- CSS style/s to apply to titlebar; usually
background:color
. The color of wikilink text must be manually changed using span tags. For example usetitle = [[Scouting|<span style="color:ivory;">Scouting</span>]]
to change the color of the link to ivory. The [show]/[hide] button and the vde link button use the color set in the titlestyle parameter. Here is an example of setting the titlestyle:titlestyle = background:darkgreen;color:ivory;
- abovestyle†
- belowstyle†
- CSS style/s to apply to the above and below parameters, respectively.
- basestyle†
- CSS style/s to apply to the title, above, below, and groupn parameters, all at the same time.
- imagestyle†
- CSS style/s to apply to the image parameter. Does not get applied to the imagen parameters.
- imageleftstyle†
- CSS style/s to apply to the imageleft parameter. Does not get applied to the imageleftn parameters.
- groupstyle
- CSS style/s to apply to all group heading parameters. Visit this website to get a lighter color similar to the title background color. Example:
groupstyle = background:lightgreen;
- groupnstyle
- CSS style/s to apply to a specific group heading; overrides any CSS styles set in groupstyle.
- liststyle†
- CSS style/s to apply to all list content parameters.
- listnstyle†
- CSS style/s to apply to specific list content parameters; overrides any CSS styles set in liststyle.
- listpadding†
- Padding to have in each list cell; defaults to 0.25em on the left/right and 0em on the top/bottom.
Examples
Basic example
{{Navbox with collapsible groups |name = University of Michigan |title = [[University of Michigan|<span style="color:#FFD700;">The University of Michigan, Ann Arbor</span>]] |titlestyle = background:#00008B;color:#FFD700; |groupstyle = background:#FFD700;color:#00008B; |image = |selected = {{{1|}}} |state = collapsed |group1 = [[University of Michigan#Academic profile|<span style="color:#00008B;">Academics</span>]] |abbr1 = academics |list1 = [[University of Michigan College of Engineering|College of Engineering]]{{·}} [[University of Michigan College of Literature, Science, and the Arts|College of Literature, Science and the Arts]]{{·}} [[Gerald R. Ford School of Public Policy]]{{·}} [[University of Michigan Law School|Law School]]{{·}} [[University of Michigan Health System|Medical School]]{{·}} [[Ross School of Business]]{{·}} [[University of Michigan School of Education|School of Education]]{{·}} [[University of Michigan School of Information|School of Information]]{{·}} [[University of Michigan School of Music, Theatre & Dance|School of Music, Theatre & Dance]]{{·}}[[University of Michigan School of Natural Resources and Environment|School of Natural Resources and Environment]]{{·}} [[University of Michigan School of Public Health|School of Public Health]]{{·}} [[Taubman College of Architecture and Urban Planning]] |group2 = [[Michigan Wolverines|<span style="color:#00008B;">Athletics</span>]] |abbr2 = athletics |list2 = [[Michigan Stadium|Michigan Stadium]]{{·}} [[Crisler Arena|Crisler Arena]]{{·}} [[Yost Ice Arena|Yost Ice Arena]]{{·}} [[Michigan Wolverines|Michigan Wolverines]]{{·}} [[Michigan Wolverines football|Football]]{{·}} [[Michigan-Ohio State rivalry|UM-OSU Rivalry]]{{·}} [[Little Brown Jug (football)|Little Brown Jug]]{{·}} [[Paul Bunyan Trophy]]{{·}} [[Cold War (ice hockey)|Cold War]] |group3 = Campus |abbr3 = campus |list3 = [[Angell Hall Observatory]]{{·}} [[Burton Tower]]{{·}} [[The Diag]]{{·}} [[David M. Dennison Building|Dennison Building]]{{·}} [[Gerald R. Ford Presidential Library]]{{·}} [[Hill Auditorium|Hill Auditorium]]{{·}} [[Lurie Tower]]{{·}} [[Matthaei Botanical Gardens]]{{·}} [[Michigan Union]]{{·}} [[Museums at the University of Michigan|Museums]]{{·}} [[Nichols Arboretum]]{{·}} [[University of Michigan Health System|UM Health System]]{{·}} [[University of Michigan Library|University Library]] }}
This example shows Template:Navbox, Template:Navbox with collapsible groups and Template:Navbox with columns all working together. Press the edit button for the section to view the code. Note that each of the child navboxes has the first parameter set to child
|
See also
- Template:Nowrap begin - Provides and explanation of the preferred method of using bullets or pipes to delimit list items.
- Template:Navbox - Basic navbox.
- Template:Navbox with columns - Sister template that provides columns in a navbox
- Template:Navbox subgroup - Allows the creation of subgroups within Template:Navbox.
Credit
This template originates from Wikipedia Template:Navbox with collapsible groups.