Template:Navbox generic

The template documentation below is transcluded from Template:Navbox generic/doc [edit]

This template employs some extremely complicated and esoteric features of template syntax. Please do not attempt to alter it unless you are certain that you understand the setup and are prepared to repair/revert any consequent collateral damage if the results are unexpected. Any experiments should be conducted in the template sandbox or your user space.

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

Blank template

{{Navbox generic
|name       = {{subst:PAGENAME}}
|state      = 
|titlestyle = background:
|title      = 
|image      = 
|bodystyle  = 

|abovestyle = 
|above      = 

|groupstyle = 
|liststyle  = 
|list(odd#)style  = 
|list(even#)style = 

|group1 = 
|list1  = 

|group2 = 
|list2  = 

|group3 = 
|list3  = 

 ...

|group20 = 
|list20  = 

|belowstyle = 
|below      = 
}}

Parameters

Deprecated (but still functional) parameter names given in parentheses before each description.

Mandatory

name

(or templateName) The name of the template, which is needed for the "v · d · e" ("view · discuss · edit") links to work properly on all pages where the template is used. You can enter {{subst:PAGENAME}} for this value as a shortcut.

title

Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use {{-}} to ensure proper centering.

The background color defaults to #ccf (truncated form of #ccccff), but can be changed via the titlestyle parameter (see below).

list_n

(i.e. list1, list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within <div> </div> (see #Example with code). At least one list parameter is required; each additional list is displayed in a separate row of the table. Each list_n may be preceded by a corresponding group_n parameter, if provided (see below).

The background color of the list items (and the entire table) defaults to #f9f9f9, but can be changed via the bodystyle, list(odd#)style and/or list(even#)style parameters (see below).

Optional

Cells

group_n

(i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of list_n. If omitted, list_n uses the full width of the table.

The background color defaults to #ddf (truncated form of #ddddff), but can be changed via the groupstyle parameter (see below).

image

An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the list1 parameter must be specified. The image parameter accepts standard wikicode for displaying an image, i.e.

[[Image:Example.jpg|100px]]

In a template where the body (the groups and/or lists) does not extend all the way to the right side, the image will shift away from the right edge of the template. This can be avoided by using the right parameter within the image wikicode, i.e.

[[Image:Example.jpg|80px|right]]

above

(or top) A full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image). In a template without an image, above behaves in the same way as the list1 parameter without the group1 parameter.

below

(or bottom) A full-width cell displayed below the template's body (groups, lists and image). In a template without an image, below behaves in the same way as the template's final list_n parameter without a group_n parameter. For an example of the below parameter in use, see {{Lists of the provinces and territories of Canada}}.

Styles

titlestyle

(or title_style, titlebkg, color) CSS styles to apply to title, specifically the titlebar's background color. At present, use as follows:

titlestyle = background:name or #nnnnnn

Use of this parameter is discouraged. Where it is used, care and consensus are needed as multiple navigational templates on one page with different background colors will probably look unpleasant.

bodystyle

Specifies CSS styles to apply to the template body. This option should be used sparingly as it can lead to visual inconsistencies. Examples:

background:#nnnnnn;

text-align:[right/center/left/justified];

width:N [em/%/px or width:auto];

float:[left/right/none];

clear:[right/left/both/none];

groupstyle

(or group_style, group-style) CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:

background:#nnnnnn;

text-align:[left/center/right];

vertical-align:[top/middle/bottom];

white-space:nowrap;

abovestyle

belowstyle

(or above_style, top-style; below_style, bottom-style) CSS styles to apply to the top cell (specified via the above parameter) and bottom cell (specified via the below parameter). Typically used to set background color or text alignment:

background:#nnnnnn;

text-align:[left/center/right];

list(odd#)style

list(even#)style

(or list(odd#)_style, odd-style; list(even#)_style, even-style) CSS styles to apply to the odd-numbered list items (list1, list3, etc) and even-numbered list items (list2, list4, etc.). Typically used to set background color (background:#nnnnnn;) in order to achieve an alternating background color between odd and even-numbered lists; see

Other

state

Defaults to autocollapse. If set to collapsed, the navbox will always start out in a collapsed state. If set to blank or anything other than autocollapse or collapsed, the navbox will always start out in an expanded state. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use collapsible. For the technically minded, see MediaWiki:Common.js.

Layout of table

Example with code

{{Navbox generic |name = {{subst:PAGENAME}} |title = [[Wikipedia:Navigational templates|Navigational templates]] |bodystyle = width:50%; |group1 = Physics |list1 = [[Template:Cosmology|Cosmology]]{{·}} [[Template:General relativity|Relativity]]{{·}} [[Template:String-theory|String theory]] |group2 = Continents |list2 = <div> [[Template:Africafooter|Africa]]{{·}} [[Template:Asiafooter|Asia]]{{·}} [[Template:Europefooter|Europe]] </div> |list3 = [[Template:National parks of Argentina|Argentinian National Parks]] }}

Additional examples

No image

With image

With image and styles

See also

Navigation template comparison

	collapsible	Header color†	Image	Groups	Style (body) parameter/s	Example
{{Navigation}}	NavFrame	NavHead	No	No	Yes	{{OPEC}}
{{Navigation with image}}	NavFrame	NavHead	Left/right of body	No	Yes	{{HolmesNovels}}
{{Navigation with columns}}	NavFrame	NavHead	No	No	Yes
{{Dynamic navigation box}}	collapsible	navbox	No	No	Yes	{{CSUHeads}}
{{Dynamic navigation box with image}}	NavFrame	NavHead	Upper left	No	No	{{SlovakPMs}}
{{Navbox generic}}	collapsible	navbox	Right-hand side	Yes	Yes	{{Dilbert}}
{{NavigationBox}}	No	navbox	Right of title+body	No	No	{{EPA}}
{{Commons:NavigationBox}}	No	#ccccff	Right of title+body	No	No
{{Commons:Dynamic navigation box}}	NavFrame	#ccccff	No	No	No
{{Commons:Dynamic navigation box with image}}	NavFrame	#ccccff	Upper left	No	No
† The background color for the header or title is inherited from the class listed below. The templates have titlestyle parameters that can be used to override the default.

Collapsible attributes

Type	CSS classes	Collapses when	Custom initial state	Nesting	Header color	Font size
NavFrame div	NavFrame, NavHead, NavContent	3+ of the same	No	Yes	#ccccff	95%
Collapsible table	collapsible, navbox	2+ of the same	Yes	Yes	#ccccff	90%
For the technically minded, see Common.css and Common.js.