Template:Navbox generic/doc

From Wikipedia, the free encyclopedia

This is the template documentation page for Template:Navbox generic. This page 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 quickly by supplying it one or more lists of links.

[edit] Blank template

{{Navbox generic
|name   = {{subst:PAGENAME}}
|title  = 
|titlebkg = 
|image  = 
|style  = 
|group-style = 
|state  = 
|top    = 
|group1 = 
|list1  = 
|group2 = 
|list2  = 
|group3 = 
|list3  = 
|group4 = 
|list4  = 
 ...
|group20 = 
|list20  = 
|bottom  = 
}}

[edit] Parameters

[edit] Mandatory

name

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

title

Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the body contents.

list_n

(i.e. list1, list2, etc.) 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. Preceded by the corresponding group_n parameter (if provided; see below).

[edit] Optional

group_n

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

titlebkg

(or color) Background color for the title. Default is  #ccf  (truncated form of  #ccccff ). Use of this parameter is discouraged. Where it is used, care and consensus are needed as multiple navigational templates on one page with different titlebar colors will probably look unpleasant.

image

An image to be displayed below the title and to the right of the body (groups/lists). For the image to display properly the list1 parameter must be specified.
The image parameter accepts standard wikicode for displaying an image, e.g. [[Image:Example.jpg|100px]]. In a template where the body (the groups and/or lists) does not extend all the way the the righthand side, the image will shift away from the righthand edge of the template. This can be avoided by using the right parameter within the image wikicode, i.e. [[Image:Example.jpg|80px|right]].

style

Specifies CSS styles to apply to the template body. For instance:
text-align:[right/center/left/justified]; width:N [em/%/px or width:auto]; float:[left/right/none]; clear:[right/left/both/none]; margin:...etc. This option should be used sparingly as it can lead to visual inconsistencies.

group-style

Specifies CSS styles to apply to the groupN cells. For instance:
background:#nnnnnn; text-align:[left/center/right]; vertical-align:[top/middle/bottom]; white-space:nowrap;...etc. This option overrides any styles that are applied to the entire table.

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.

top

(or above) A full-width cell displayed below the title and above the body (groups, lists and image). In a template without an image, top behaves like the list1 parameter without the group1 parameter.

bottom

(or below) A full-width cell displayed below the groups, lists and image. In a template without an image, bottom behaves like the template's final list_n parameter without a group_n parameter. It is named bottom to match the parameter used in the former {{Navbox generic with image}} template. For an example of the bottom parameter in use, see {{Lists of the provinces and territories of Canada}}.

[edit] Layout of table

[edit] Example with code

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

[edit] Additional examples

[edit] No image

[edit] With image

v • d • e MSC (Multimedia Super Corridor) Malaysia - with image
MSC Centre	Cyberjaya
MSC Area	Klang Valley
MSC Major Landmarks	Petronas Twin Towers • Kuala Lumpur Tower • Kuala Lumpur Sentral • Technology Park Malaysia • Putrajaya • Cyberjaya • Kuala Lumpur International Airport
MSC Infrastructure	Express Rail Link • KL-KLIA Dedicated Expressway
MSC Prime Applications	EGovernment • MyKad

[edit] With image and styles

v • d • e MSC (Multimedia Super Corridor) Malaysia - with image; body (lists): left-aligned text on white background; groups: right-aligned text and don't wrap white space; bottom: center-aligned text on a light blue background
MSC Centre	Cyberjaya
MSC Area	Klang Valley
MSC Major Landmarks	Petronas Twin Towers • Kuala Lumpur Tower • Kuala Lumpur Sentral • Technology Park Malaysia • Putrajaya • Cyberjaya • Kuala Lumpur International Airport
MSC Infrastructure	Express Rail Link • KL-KLIA Dedicated Expressway
MSC Prime Applications	EGovernment • MyKad
MSC Website: www.msc.com.my

[edit] See also