CapybaraKiller: 1 revision imported from :Wikipedia:Template:Navbox_with_collapsible_groups/doc

2025-05-26T07:09:33Z

1 revision imported from Wikipedia:Template:Navbox_with_collapsible_groups/doc

← Older revision	Revision as of 00:09, 26 May 2025
(No difference)

Wikipedia>Ahecht: {{Lua|Module:Navbox}}

2025-01-24T15:22:36Z

New page

{{Documentation subpage}}
{{High-risk| 109000 }}
{{Lua|Module:Navbox}}
<includeonly>{{Template display|nomobile}}</includeonly>
{{Navbox suite}}
{{Collapsible templates}}

This template produces a [[Wikipedia:Navigation template|navigation 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.

== Usage ==

Please remove the parameters that are left blank. The template currently supports up to 20 groups/lists but more can be added if needed. You should use a minimum of two groups/lists; otherwise, use {{tl|Navbox}} instead.

<syntaxhighlight lang="wikitext">
{{Navbox with collapsible groups
| name = {{subst:PAGENAME}}
| title =
| listclass = hlist
| state = {{{state|}}}
| selected = {{{selected|{{{1|}}}}}}

| above =
| image =

| abbr1 =
| group1 =
| list1 =

| abbr2 =
| group2 =
| list2 =



| abbr20 =
| group20 =
| list20 =
}}
</syntaxhighlight>

== Parameters ==

This template shares many common parameters with its sister templates {{tl|Navbox}} and {{tl|Navbox with columns}}. The common parameters are marked with a cross'''†'''. Please refer to the documentation of {{tl|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''† [<code>uncollapsed, collapsed, plain, off</code>]
::The initial state of the show/hide feature for the main title. See {{tl|Navbox}} for more information. Does not affect display or hiding of group items, see ''staten'', below.

:;''navbar''†
::Possible values are <code>plain</code>, <code>off</code>, and the default value of blank. See {{tl|Navbox}} for more information.

:;''border''†
::Possible values are <code>child</code>, <code>none</code>, and the default value of blank. Set to <code>child</code> 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 {{tl|Navbox}}, the columns of a {{tl|Navbox with columns}}, or a list area of {{tl|Navbox with collapsible groups}}. See {{tl|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. {{strikethrough|Use dots or bullets as separators (see the [[#See also|See also]] section).}} A {{tl|Navbox}} or {{tl|Navbox with columns}} can optionally be used here with its <code>border = child</code> 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 <code>selected</code> parameter immediately below to see how to use this parameter. This parameter is optional, but recommended.

:; ''selected''
:: If the value of <code>selected</code> equals the value of <code>abbrn</code>, then listn is uncollapsed and all other lists are collapsed. If <code>selected</code> is left blank, or if it does not match any <code>abbrn</code>, then all groups are collapsed. Usually this parameter should be set to <code><nowiki>{{{1|}}}</nowiki></code>. 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.

:: The collapsed/uncollapsed options can be listed on the template's page by using the {{tl|Collapsible sections option}} template in the <nowiki><noinclude></nowiki> part of the page.

:; ''staten'' [<code>uncollapsed, collapsed, plain, off</code>]
:: The initial collapsible state of listn. Set to collapsed by default. Overridden to uncollapsed if <code>selected</code> equals <code>abbrn</code>.

:; ''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''†
::[[Wikipedia:CSS|CSS]] style/s to apply to titlebar; usually <code>background:''color''</code>. The color of wikilink text must be manually changed using span tags. For example use <code><nowiki>title = [[Scouting|Scouting]]</nowiki></code> 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:
:::<code>titlestyle = background:darkgreen;color:ivory;</code>

:;''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 [http://meyerweb.com/eric/tools/color-blend/ this website] to get a lighter color similar to the title background color. Example:
:::<code>groupstyle = background:lightgreen;</code>

:; ''groupn''style†
:: 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.

:; ''listn''style†
:: 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.

===Microformat parameters===
:; ''bodyclass''†
:: This parameter is inserted into the "class" attribute for the infobox as a whole.

:; ''titleclass''†
:: This parameter is inserted into the "class" attribute for the infobox's title caption.

:See [[Wikipedia:WikiProject Microformats]] for more information on adding microformat information to Wikipedia, and [[microformat]] for more information on microformats in general.

== Examples ==
===Basic example===
<syntaxhighlight lang="wikitext" style="overflow:scroll;">
{{Navbox with collapsible groups
|name = University of Michigan
|state = uncollapsed
|title = [[University of Michigan|The University of Michigan, Ann Arbor]]
|titlestyle = background:#00008B;color:#FFD700;
|listclass = hlist
|groupstyle = background:#FFD700;color:#00008B;
|image =
|selected = {{{1|}}}

|group1 = [[University of Michigan#Academic profile|Academics]]
|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|Athletics]]
|abbr2 = athletics
|state2 = uncollapsed
|list2 =
* [[Michigan Stadium]]
* [[Crisler Arena]]
* [[Yost Ice Arena]]
* [[Michigan Wolverines]]
* [[Michigan Wolverines football|Football]]
* [[Michigan – Ohio State football rivalry|UM-OSU Rivalry]]
* [[Little Brown Jug (American football)|Little Brown Jug]]
* [[Paul Bunyan Trophy]]
* [[Cold War (ice hockey)|Cold War]]

|group3 = Campus
|abbr3 = campus
|list3 =
* [[Angell Hall Observatory]]
* [[Burton Memorial Tower|Burton Tower]]
* [[The Diag]]
* [[David M. Dennison Building|Dennison Building]]
* [[Gerald R. Ford Presidential Library]]
* [[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]]
}}
</syntaxhighlight>
{{Navbox with collapsible groups
|name = University of Michigan
|state = uncollapsed
|title = [[University of Michigan|The University of Michigan, Ann Arbor]]
|titlestyle = background:#00008B;color:#FFD700;
|listclass = hlist
|groupstyle = background:#FFD700;color:#00008B;
|image =
|selected = {{{1|}}}

|group1 = [[University of Michigan#Academic profile|Academics]]
|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|Athletics]]
|abbr2 = athletics
|state2 = uncollapsed
|list2 =
* [[Michigan Stadium]]
* [[Crisler Arena]]
* [[Yost Ice Arena]]
* [[Michigan Wolverines]]
* [[Michigan Wolverines football|Football]]
* [[Michigan – Ohio State football rivalry|UM-OSU Rivalry]]
* [[Little Brown Jug (American football)|Little Brown Jug]]
* [[Paul Bunyan Trophy]]
* [[Cold War (ice hockey)|Cold War]]

|group3 = Campus
|abbr3 = campus
|list3 =
* [[Angell Hall Observatory]]
* [[Burton Memorial Tower|Burton Tower]]
* [[The Diag]]
* [[David M. Dennison Building|Dennison Building]]
* [[Gerald R. Ford Presidential Library]]
* [[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]]
}}

===Nesting navboxes===
To nest a navbox inside a {{ROOTPAGENAME}}, set the <code>listn</code> parameter to <code>child</code> or <code>subgroup</code>. Elements of the child navbox can be specified by prepending <code>childn_</code>, <code>subgroupn_</code>, or just <code>n_</code> to the parameter names (e.g. <code>1_list1</code>). Child navboxes can be nested by adding an additional prefix (e.g. <code>1_1_list1</code>). The basic code for doing this is as follows (which adds a subgroup for the first group/list area):

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Navbox with collapsible groups
| name = {{subst:PAGENAME}}
| title = Title

| group1 = Group Title
| list1 = child
| 1_title = [optional]

| 1_group1 = [optional]
| 1_list1 = child
| 1_1_title = [optional]

| 1_1_group1 = [optional]
| 1_1_list1 =
...list contents...
...
...
}}
</syntaxhighlight>

{{Navbox with collapsible groups
| name = Navbox with collapsible groups/doc
| title = Navbox with collapsible groups with nested Navboxes

| group1 = Group 1 Title
| list1 = child
| 1_group1 = Group 1 Child Navbox Group 1
| 1_list1 = child
| 1_1_group1 = Group 1 Child Navbox's Child Navbox Group 1
| 1_1_list1 = Group 1 Child Navbox's Child Navbox List 1
| 1_1_list2 = Group 1 Child Navbox's Child Navbox List 2
|1_group2 = Group 1 Child Navbox Group 2
|1_list2 = Group 1 Child Navbox List 2
}}

{{tl|Navbox with collapsible groups}} or {{tl|Navbox with columns}} can be nested by setting the <code>n_type</code> parameter to "with collapsible groups" or "with columns".

==== Relationship with other Navbox templates ====
This navbox template works in conjunction with two other templates: {{tl|Navbox}} and {{tl|Navbox with columns}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in the [[Template:Navbox/doc#Parameter descriptions|parameter descriptions]] list at [[Template:Navbox/doc]]). Most importantly, each template can be used as a child of one another. Using the inline notation, the <code>n_type=</code> parameter can be set to <code>with columns</code> or <code>with collapsible groups</code> to set the type of that child navbox, as shown in the example below. Press the edit button for the section to view the code.

{{Navbox with collapsible groups
|name = Template:Navbox with collapsible groups/doc
|title = Navbox with Collapsible Groups with nested regular Navbox, Navbox with Collapsible Groups, and Navbox with Columns
|listclass = hlist
|group1 = Regular Navbox
|list1 = subgroup
|1_group1 = Group 1
|1_list1 =
* List 1.1
* List 1.2
|1_group2 = Group 2
|1_list2 =
* List 2.1
* List 2.2
|group2 = Navbox with Collapsible Groups
|list2 = subgroup
|2_type = with collapsible groups
|2_group1 = Group 1
|2_list1 =
* List 1.1
* List 1.2
|2_group2 = Group 2
|2_list2 =
* List 2.1
* List 2.2
|group3 = Navbox with Columns
|list3 = subgroup
|3_type = with columns
|3_col1header = Column 1
|3_col1 =
* List 1.1
* List 1.2
|3_col2header = Column 2
|3_col2 =
* List 2.1
* List 2.2
}}

You can also nest these navbox templates by using the {{para|border|child}} parameter, or by specifying the first unnamed parameter to be <code>child</code>. For example: <code><nowiki>{{Navbox|child ...}}</nowiki></code>, <code><nowiki>{{Navbox with columns|child ...}}</nowiki></code> or <code><nowiki>{{Navbox with collapsible groups|child ...}}</nowiki></code>. Note that this style of nesting can lead to a large increase in the template's [[WP:PEIS|post-expand include size]].

==Technical details==
* This template is a shortcut for the syntax shown at {{sectionlink|Template:Navbox/doc#Multiple show/hides in a single container}}. It uses [[Module:Navbox]] to render the actual navbox.
* Navbox templates, including this one, are a major contributor to the [[WP:PEIS|post-expand include size]] of pages, and can cause pages to exceed the limit and not render correctly. There are a few ways to mitigate this.
** {{tlx|{{ROOTPAGENAME}}}} can be replaced with {{mlx|Navbox|with collapsible groups}}, which approximately halves the include size
** Nesting other templates inside of a navbox can cause the include size increase by a factor of two or more. This template currently supports the same in-line child syntax documented at [[Template:Navbox/doc#Child navboxes]], which mitigates this, but only for plain Navboxes, Navboxes with collapsible groups, and Navboxes with columns.

== See also ==
* {{tl|Navboxes}} (and {{tl|Navboxes top}})
* {{tl|Collapsible sections option}}
* {{strikethrough|{{tl|Nowrap begin}} – Provides an explanation of the preferred method of using bullets or pipes to delimit list items.}} Deprecated; use the <code>hlist</code> class.
* {{sectionlink|Template:Navbox/doc#Multiple show/hides in a single container}}
{{Navigation templates}}

<includeonly>{{Sandbox other||

[[Category:Navigational box metatemplates|collapsible groups]]
[[Category:Collapse templates]]
}}</includeonly>

Template:Navbox with collapsible groups/doc - Revision history

CapybaraKiller: 1 revision imported from :Wikipedia:Template:Navbox_with_collapsible_groups/doc

Wikipedia>Ahecht: {{Lua|Module:Navbox}}