Template: Navbox/doc

This is the template documentation page for {{Navbox/doc}}. It is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

---

This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links. It is similar to {{Navbox generic}} in appearance, with some default styles that should work for most navigational templates. It is not recommended that one modifies the default styles, but it is possible if one wishes to do so.

Blank template

{{Navbox
|name    = {{subst:PAGENAME}}
|state   = 
|title   = 
|image   = 
|above   = 

|group1  = 
|list1   = 

|group2  = 
|list2   = 

 ...

|group20 = 
|list20  = 

|below   = 
}}

Parameters

Mandatory

name

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.

list_n (body may be used in place of list1)

(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>. 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).

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.

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]]

imageleft

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

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

above

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

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 (NOT RECOMMENDED)

Styles are not recommended as to maintain consistency among templates and pages in Wikipedia. However, the option to modify styles is given in case it is necessary.

titlestyle

CSS styles to apply to title, most often the titlebar's background color:

titlestyle = background:#nnnnnn;

titlestyle = background:name;

bodystyle

Specifies CSS styles to apply to the template body. The shorter name style may be used when no other style parameters are specified. This option should be used sparingly as it can lead to visual inconsistencies. Examples:

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

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

float:[left/right/none];

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

groupstyle

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];

liststyle

CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) below.

oddstyle

evenstyle

Applies to odd/even list numbers. Overrules styles defined by liststyle. The default behavior is to add striped colors (white and gray) to odd/even rows, respectively, in order to improve readability. These should not be changed except in extraordinary circumstances.

abovestyle

belowstyle

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];

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.

Often times, editors will want a default initial state for a nav box, which may be overridden in an article. Here is the trick to do this:

In your intermediate template, create a parameter also named "state" as a pass-through like this

| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}

Example: {{peso}} with autocollapse as the default initial state. Bolivian peso transcludes it and has only one nav box. So the peso nav box shows. Chilean peso has two nav boxes. So the peso nav box collapses.

Example: {{Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.

The <includeonly>| will make the template expanded when viewing the template page by itself.

navbar

Defaults to Tnavbar. If set to plain, the links on the left side of the titlebar will not be displayed.

Layout of table

Table generated by {{Navbox}} without image, above and below parameters (borders added for illustration only):

Table generated by {{Navbox}} with image, above and below parameters (borders added for illustration only):

Table generated by {{Navbox}} with image, imageleft, lists, and without groups, above, below:

Examples

No image

{{Navbox
|name   = Navbox/doc
|title  = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]{{-}}''without image''
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}} 
[[Kuala Lumpur Tower]]{{·}} 
[[Kuala Lumpur Sentral]]{{·}} 
[[Technology Park Malaysia]]{{·}} 
[[Putrajaya]]{{·}} 
[[Cyberjaya]]{{·}} 
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]]  
}}

With image, without groups

{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|list1  = <div>
[[Petronas Twin Towers]]{{·}} 
[[Kuala Lumpur Tower]]{{·}} 
[[Kuala Lumpur Sentral]]{{·}} 
[[Technology Park Malaysia]]{{·}} 
[[Putrajaya]]{{·}} 
[[Cyberjaya]]{{·}} 
[[Kuala Lumpur International Airport]]
</div>
}}

With two images, without groups, multiple lists

{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|imageleft = [[Image:Flag of Malaysia.svg|80px]]
|list1  = [[Petronas Twin Towers]]{{·}} [[Kuala Lumpur Tower]]{{·}} [[Kuala Lumpur Sentral]]
|list2  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|list3  = [[EGovernment]]{{·}} [[MyKad]]
|list4  = [[Klang Valley]]
}}

With image, groups, above, below

{{Navbox
|name  = Navbox/doc
|title = [[Multimedia Super Corridor|MSC (Multimedia Super Corridor) Malaysia]]
|image = [[Image:Flag of Malaysia.svg|80px]]
|above = Above text goes here
|group1 = Centre
|list1  = [[Cyberjaya]]
|group2 = Area
|list2  = [[Klang Valley]]
|group3 = Major landmarks
|list3  = <div>
[[Petronas Twin Towers]]{{·}} 
[[Kuala Lumpur Tower]]{{·}} 
[[Kuala Lumpur Sentral]]{{·}} 
[[Technology Park Malaysia]]{{·}} 
[[Putrajaya]]{{·}} 
[[Cyberjaya]]{{·}} 
[[Kuala Lumpur International Airport]]
</div>
|group4 = Infrastructure
|list4  = [[Express Rail Link]]{{·}} [[KL-KLIA Dedicated Expressway]]
|group5 = Prime applications
|list5  = [[EGovernment]]{{·}} [[MyKad]]
|below  = Website: [http://www.msc.com.my/ www.msc.com.my]
}}

See also

	collapsible	Image	Groups	Default header color	Style parameter	Example
{{Navigation}}	NavFrame	No	No	#efefef	No	{{OPEC}}
{{Navigation with image}}	NavFrame	Left/right of body	No	#efefef	No	{{Cetaceans}}
{{Dynamic navigation box}}	collapsible	No	No	#ccccff	Yes	{{CSUHeads}}
{{Dynamic navigation box with image}}	NavFrame	Upper left	No	#efefef	No	{{Cities and towns in Ostalb (district)}}
{{Navbox generic}}	collapsible	No	Yes	#ccccff	Yes	{{Dilbert}}
{{Navbox generic with image}}	collapsible	Right-hand side	Yes	#ccccff	Yes
{{NavigationBox}}	No	Right of header+body	No	#ccccff	No	{{EPA}}
{{Navigation no hide}}	No	No	No	#eee	No
{{Commons:NavigationBox}}	No	Right of header+body	No	#ccccff	No
{{Commons:Dynamic navigation box}}	NavFrame	No	No	#ccccff	No
{{Commons:Dynamic navigation box with image}}	NavFrame	Upper left	No	#efefef	No

	CSS class	collapses when†	custom initial state	Nesting
NavFrame	NavFrame	3+ of the same	No	Yes
collapsible	navbox, collapsible	2+ of the same	Yes	No
† For the technically minded, see MediaWiki:Common.js.

Credits

New World Encyclopedia writers and editors copied and adjusted this Wikipedia template in accordance with New World Encyclopedia standards. This article abides by terms of the Creative Commons CC-by-sa 3.0 License (CC-by-sa), which may be used and disseminated with proper attribution.The history of earlier contributions by wikipedians is accessible to researchers here:

• Template:Navbox/doc  ^history

The history of this article since it was imported to New World Encyclopedia:

• History of "Template:Navbox/doc"

Note: Some restrictions may apply to use of individual images which are separately licensed.