Template:Navbox

(view - edit - history - purge) Documentation

This template is used for creating navigational templates (also known as navboxes).

Usage

Please remove the parameters that are left blank.

{{Navbox
| name  = {{subst:PAGENAME}}{{subst:null|Don't change anything on this line. It will change itself when you save.}}
| title =
| state = {{{state|}}}

| above =

| group1 =
| list1  =

| group2 =
| list2  =

| group3 =
| list3  =

<!-- ... (up to group30 & list30) -->

| below =
}}

Parameters

Setup parameters

name — the title portion of the template's page location, i.e. [[Template:NAME HERE]]. Required for the top-left navbar to work properly.

When creating a new navbox, you can set this parameter to {{subst:PAGENAME}}; this will automatically turn into the template's name when you save your changes.

state — sets the initial collapsed state. Common values include autocollapse, collapsed, uncollapsed and expanded. Defaults to autocollapse. It is strongly recommended to set this parameter to {{{state|}}}, as this allows users to change the navbox's state locally, e.g. {{Creatures|state=expanded}}.

autocollapse — hides the content if there is another collapsible element on the page. Otherwise, it shows the content.

collapsed — hides the content.

expanded or uncollapsed — shows the content.

navbar — disables the navigation links on the top-left. Only accepts off.

border or {{{1}}} — accepted values are subgroup and child. See § Child navboxes.

Cells

title — title text.

above — text between the title bar and the first group/list.

groupn (group1, group2, ... , group30) — text displayed inside a box on the left side of its list. Can be omitted. It won't display if its list is empty or undefined.

listn (list1, list2, ... , group30) — main content, usually a list of links. Unlike group, it can exist on its own; if group is omitted, the text will be centered.

below — footer text (bar below groups and lists).

Style parameters

Quotations ("") or style= are unnecessary.

bodystyle — CSS style for the <table> element.

titlestyle — CSS style for the title bar.

basestyle — Combination of titlestyle, abovestyle, belowstyle and groupstyle. Overwritten by titlestyle, abovestyle, belowstyle, groupstyle and group_nstyle.

abovestyle — CSS style for the above bar.

belowstyle — CSS style for the below bar.

groupstyle — CSS style for all group boxes.

groupnstyle — CSS style for a specific group box, where _n denotes the group (group1style → group1, etc.).

liststyle — CSS style for all lists.

listnstyle — CSS style for a specific list, where _n denotes the list (list1style → list1, etc.).

listpadding — sets the padding for lists. Default is 0em 0.25em.

Default styles

bodystyle  = background: #fdfdfd; border: 1px solid #aaa; font-size: 88%; margin: 0 auto -1px; vertical-align: middle; width: 60%;
titlestyle = background: #ccccff; border: 1px solid #aaa; padding: 0.25em 1em; text-align: center;
abovestyle = background: #ddddff; padding: 0.25em 1em; text-align: center;
belowstyle = background: #ddddff; padding: 0.25em 1em; text-align: center;
groupstyle = background: #ddddff; padding: 0.25em 1em; text-align: right; white-space: nowrap; width: 1%;
liststyle  = background: transparent; padding: 0; text-align: left/center;

A list defaults to text-align: left; if it has a group, if not it defaults to text-align: center;. Although lists have their padding set to 0, as shown here, the actual value is 0 0.25em;, which is defined in each list's <div> instead.

Layout

Without above and below

V · T · E {{{title}}}
{{{group1}}}	{{{list1}}}
{{{group2}}}	{{{list2}}}
{{{list3}}} without {{{group3}}}
{{{group4}}}	{{{list4}}}

With above and below

V · T · E {{{title}}}
{{{above}}}
{{{group1}}}	{{{list1}}}
{{{group2}}}	{{{list2}}}
{{{list3}}} without {{{group3}}}
{{{group4}}}	{{{list4}}}
{{{below}}}

Without groups, above and below

V · T · E {{{title}}}
{{{list1}}}
{{{list2}}}
{{{list3}}}
{{{list4}}}

Example

{{Navbox
| name  = Navbox/doc
| title = [[Soil]]
| state = expanded
| navbar = off
| titlestyle = background-color: #FFFF00;
| basestyle = background-color: #C0C0C0;

| group1 = Topsoil
| list1  = [[Loam]] • [[Loamy sand]] • [[Peat]] • [[Sandy clay loam]] • [[Sandy loam]] • [[Silt]] • [[Silt loam]] • [[Silty clay loam]]

| group2style = background-color: #00FFFF; color: white;
| group2 = Ocean floor
| list2  = [[Calcareous ooze]] • [[Pelagic clay]] • [[Siliceous ooze]]

| group3 = [[Sand]]
| list3  = [[Sand (tan)]] • [[Black sand]] • [[Red sand]] • [[White sand]] • [[Yellow sand]]

| group4 = Clay
| list4style = border: 1px solid black; font-size: 114%;
| list4  = [[Clay]] • [[Clay loam]] • [[Fire clay]] • [[Sandy clay]] • [[Silty clay]]

| below = See also: [[Template:DF2014 stones|Stones]]
}}

Soil
Topsoil	Loam • Loamy sand • Peat • Sandy clay loam • Sandy loam • Silt • Silt loam • Silty clay loam
Ocean floor	Calcareous ooze • Pelagic clay • Siliceous ooze
Sand	Sand (tan) • Black sand • Red sand • White sand • Yellow sand
Clay	Clay • Clay loam • Fire clay • Sandy clay • Silty clay
See also: Stones

Child navboxes

Usage

{{Navbox
| name = {{subst:PAGENAME}}
| title = Title

| group1 = [optional]
| list1  = {{Navbox|child
   ...child navbox parameters...
 }}

...
}}

Multiple subgroups example

{{Navbox
| name  = Navbox/doc
| title = Multiple subgroups example
| state = expanded
| above = Above

| group1 = Group 1
| list1 = List 1

| group2 = Group 2
| list2 = {{Navbox|child
  | group1 = Group 2.1
  | list1 = List 2.1
  | list2 = List 2.2 ''without Group 2.2''
  | group3 = Group 2.3
  | list3 = List 2.3
 }}

| group3 = Group 3
| list3 = List 3

| group4 = Group 4
| list4 = {{Navbox|child
  | group1 = Group 4.1
  | list1 = List 4.1
  | group2 = Group 4.2
  | list2 = {{Navbox|child
    | group1 = Group 4.2.1
    | list1 = List 4.2.1
    | group2 = Group 4.2.2
    | list2 = {{Navbox|child
      | group1 = Group 4.2.2.1
      | list1 = List 4.2.2.1
     }}
    | group3 = Group 4.2.3
    | list3 = List 4.2.3
   }}
  | group3 = Group 4.3
  | list3 = List 4.3
 }}

| below = Below
}}

V · T · E Multiple subgroups example
Above
Group 1	List 1
Group 2	Group 2.1 List 2.1 List 2.2 without Group 2.2 Group 2.3 List 2.3
Group 3	List 3
Group 4	Group 4.1 List 4.1 Group 4.2 Group 4.2.1 List 4.2.1 Group 4.2.2 Group 4.2.2.1 List 4.2.2.1 Group 4.2.3 List 4.2.3 Group 4.3 List 4.3
Below

Collapsible subgroups example

{{Navbox
| name   = Navbox/doc
| title  = Collapsible subgroups example
| state  = expanded

| list1  = {{Navbox|child
  | title  = Collapsible subgroup 1
  | group1 = Group 1.1
  | list1  = List 1.1
  | group2 = Group 1.2
  | list2  = List 1.2
 }}

| list2  = {{Navbox|child
  | title  = Collapsible subgroup 2
  | state  = expanded
  | above  = Above
  | group1 = Group 2.1
  | list1  = List 2.1
  | group2 = Group 2.2
  | list2  = List 2.2
  | below  = Below
 }}

| group3 = Group 3
| list3  = {{Navbox|child
  | title  = Collapsible subgroup 3
  | group1 = Group 3.1
  | list1  = List 3.1
  | group2 = Group 3.2
  | list2  = List 3.2
 }}
}}

V · T · E Collapsible subgroups example
Collapsible subgroup 1 Group 1.1 List 1.1 Group 1.2 List 1.2
Collapsible subgroup 2 Above Group 2.1 List 2.1 Group 2.2 List 2.2 Below
Group 3	Collapsible subgroup 3 Group 3.1 List 3.1 Group 3.2 List 3.2