Template:Navbox/doc

Description

This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links.

It comes equipped with default styles that should work for most navigational templates. Changing the default styles is not recommended, but is possible.

Dependencies

• Template:NavboxCSS

Syntax

{{Navbox
|bodyclass = 
|name = {{subst:PAGENAME}}
|title = 
|titleclass = 
|state =
|titlestyle =
|groupstyle = 
|image = 
|imageleft =
|above = 

|group1 = 
|list1 = 

|group2 = 
|list2 = 
 ...
|group20 = 
|list20 = 

|below = 
}}

Parameters

The only mandatory parameters are name, title and list1.

bodyclass

Applies an HTML class attribute to the entire navbox. Use sparingly!

name

The name of the template. Set to {{subst:PAGENAME}} by default.

title

Text in the title bar.

titleclass

Applies an HTML class attribute to the title bar. Use sparingly!

state = [autocollapse, collapsed, expanded, plain, off]

The status of box expansion. Use sparingly!

• Defaults to autocollapse. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded.
• If set to collapsed, the navbox will always start out in a collapsed state.
• If set to expanded, the navbox will always start out in an expanded state.
• If set to plain, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered.
• If set to off, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.

titlestyle

A CSS style for the title-bar, such as: background:gray; Use sparingly!

groupstyle

A CSS style for the group-cells, such as: background:#eee; Use sparingly!

image

An optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as [[File:XX.jpg|90px|link=|alt=]]. Use sparingly!

imageleft

An optional left-side image (code the same as the "image" parameter). Use sparingly!

above

Text to appear above the group/list section (could be a list of overall wikilinks).

groupn

The left-side text before list-n (if group-n omitted, list-n starts at left of box).

listn

Text listing links. See Template:Flatlist.

below

Optional text to appear below the group/list section.

Sample output

{{Navbox
|name = {{subst:PAGENAME}}
|title = Navigational box title
|above = Text written below the title and above the link lists.

|group1 = Group One
|list1 = {{flatlist|
* [[EVE University]]
* [[EVE University Management]]
* [[EVE University Rules]]
}}

|group2 = Group Two
|list2 = {{flatlist|
# [[EVE University]]
# [[EVE University Management]]
# [[EVE University Rules]]
}}

|group20 = Group Twenty Test Test
|list20 = {{flatlist|
* [[EVE University]]
** [[EVE University Management]]
** [[EVE University Rules]]
}}

|below = Text written below the link lists.
}}

gives...

See also

• Template:Flatlist
• Wikipedia Navbox