Template:Navbox generic/doc

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

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


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

Optional

 * groupn
 * (i.e. group1, group2, etc.) If specified, text appears in a header displayed to the left of listn. If omitted, listn 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. ...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: ...etc. This option overrides any styles that are applied to the entire table.


 * state
 * Defaults to . If set to , the navbox will always start out in a collapsed state. If set to blank or anything other than   or  , the navbox will always start out in an expanded state. A navbox with   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 listn parameter without a groupn 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.