Template:Navbox subgroup/doc

From Wikibooks, open books for an open world
Jump to navigation Jump to search

This template is designed to be used with {{Navbox}} or other navigational templates that allow creating lists of links with groups headers or titles. This template allows the creation of subgroups that can be assigned to a list item within {{Navbox}}. A subgroup may contain up to 20 list items.

Blank template[edit source]

{{Navbox subgroup
| groupstyle = 
| liststyle  = 

| group1 = 
| list1  = 
| group2 = 
| list2  = 
| group20 = 
| list20  = 

Parameters[edit source]

This template employs all parameters of {{Navbox}}. Please see the documentation there for more complete descriptions. In fact, the only differences between this template and {{Navbox}} are as follows:

  • The border parameter defaults to "child"
  • The group padding defaults to 0.75em on the left/right, and can only be changed with the grouppadding parameter. This is done to prevent the Internet Explorer box model bug from affecting the width of groups.

Everything else is exactly the same as {{Navbox}}.

Only the most common parameters are listed below.

Cells[edit source]

(i.e. list1, list2, ... list20) The body of the template, usually a list of links. Format is inline. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter, if provided (see below). The background color of the list items (and the entire table) defaults to transparent, therefore it displays the same background color used in the parent navigation box.
(i.e. group1, group2, ..., group20) If specified, text appears in a header cell displayed to the left of listn. If omitted, listn uses the full width of the table. The background color defaults to #e6e6ff, but can be changed via the groupstyle parameter (see below).

Styles[edit source]

Specifies CSS styles to apply to the template body. Examples:
CSS styles to apply to the groupn cells. This option overrides any styles that are applied to the entire table. Examples:
CSS style to specify group padding. Should usually be specified using em units. It is recommended to leave this parameter alone and use the default padding. Examples:
grouppadding = 0em 1em; (1em on left/right, 0em on top/bottom)
grouppadding = 0em 0.5em 0em 1em; (0em top, 0.5em right, 0em bottom, 1em left)
CSS styles to apply to all lists. Overridden by the oddstyle and evenstyle parameters (if specified) below.
CSS styles to apply to the odd-numbered list items (list1, list3, etc) or even-numbered list items (list2, list4, etc), respectively. Typically used to set background color (background:#nnnnnn;) in order to achieve an alternating background color between odd and even-numbered lists.
evenodd [swap, even, odd, off]
If set to swap, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to even or odd sets all rows to have that striping color. Setting to off disables automatic row striping. NOTE: Due to system limitations, do not use a semi-colon to close this command.

Setting the width of groups[edit source]

If multiple {{Navbox subgroup}} templates are used inside of a parent {{Navbox}}, it generally looks better if the width of the groups matches up. In order to do this, one must set the groupstyle parameters to contain the desired width, and the liststyle parameters to have width:auto (due to HTML/CSS reasons). For example, place the following code in each {{Navbox subgroup}} to adjust the widths:

groupstyle = width:10em;
liststyle = width:auto;
  • NOTE: For the groupstyle widths to work, you must set the liststyle width to "auto".

If you also use the image or imageleft parameters, then you will most likely also need to set their width manually using the imagestyle and imageleftstyle parameters.

Examples[edit source]

Example 1[edit source]

The following is an example of Navbox subgroup used within a Navbox template.

| state  = uncollapsed
| name   = Protected Areas of Colorado
| title  = Protected Areas of Colorado
| group1 = National Park Service
| list1  =
  {{Navbox subgroup
  | group1 = National Parks
  | list1  = Black Canyon of the Gunnison{{·}} |Great Sand Dunes{{·}} Mesa Verde{{·}} Rocky Mountain
  | group2 = National Monuments
  | list2  = Colorado{{·}} Florissant Fossil Beds{{·}} Hovenweep{{·}} Yucca House
  | group3 = National Historic Sites
  | list3  = Bent's Old Fort{{·}} Sand Creek Massacre
  | group4 = National Recreation Area
  | list4  = Curecanti
| group2 = National Forests
| list2  = Arapaho{{·}} Grand Mesa{{·}} Gunnison{{·}} |Pike{{·}} Rio Grande{{·}} Roosevelt{{·}} Medicine Bow - Routt{{·}} San Isabel{{·}} San Juan{{·}} Uncompahgre{{·}} White River

Example 2[edit source]

This example implements horizontal group headings by assigning the headings to list1 and list3 and the links to list2 and list4), then using list1style and list3style to set the background color of the headings.

| name  = Roman Emperors
| title = Roman Emperors
| group1 = Crisis 235 AD - 284 AD
| list1  = Maximinus Thrax{{·}} Gordian I{{·}} Gordian II{{·}} Pupienus and Balbinus{{·}} Gordian III{{·}} Philip the Arab{{·}} Decius{{·}} Trebonianus Gallus{{·}} Aemilianus{{·}} Valerian{{·}} Gallienus{{·}} Claudius II{{·}} Quintillus{{·}} Aurelian{{·}} Marcus Claudius Tacitus{{·}} Florianus{{·}} Probus{{·}} Carus{{·}} Numerian{{·}} Carinus
| group2 = Dominate
| list2  = 
  {{Navbox subgroup
   |list1style = background:#ddf;
   |list1 = '''284 AD - 395 AD'''
   |list2 = Diocletian{{·}} Maximian{{·}} Constantius I{{·}} Galerius{{·}} Severus II{{·}} Maxentius{{·}} Maximinus{{·}} Licinius{{·}} Constantine I{{·}} Constantine II{{·}} Constans I{{·}} Constantius II{{·}} Julian the Apostate{{·}} Jovian{{·}} Valentinian I{{·}} Valens{{·}} Gratian{{·}} Valentinian II{{·}} Eugenius{{·}} Theodosius I
   |list3style = background:#ddf;
   |list3 = '''Western Empire (393 AD - 476 AD)'''
   |list4 = Honorius{{·}} Constantius III{{·}} Joannes{{·}} Valentinian III{{·}} Petronius Maximus{{·}} Avitus{{·}} Majorian{{·}} Libius Severus{{·}} Anthemius{{·}} Olybrius{{·}} Glycerius{{·}} Julius Nepos{{·}} Romulus Augustus

See also[edit source]