Template:Navbox generic/doc

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

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  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  (truncated form of  ), but can be changed via the titlestyle parameter (see below).


 * listn
 * (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  (see ).  At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter, if provided (see below).
 * The background color of the list items (and the entire table) defaults to, but can be changed via the bodystyle, oddstyle and/or evenstyle parameters (see below).

Cells

 * groupn
 * (i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of listn. If omitted, listn uses the full width of the table.
 * The background color defaults to  (truncated form of  ), 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.


 * bodystyle or style
 * 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:


 * groupstyle
 * CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:


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


 * oddstyle
 * evenstyle
 * CSS styles to apply to the odd-numbered list items (list1, list3, etc) or even-numbered list items (list2, list4, etc), respectively. Typically used to set background color in order to achieve an alternating background color between odd and even-numbered lists; see Turkey topics for an example.


 * 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:

Default styles
The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple.



Since all but groupstyle and titlestyle have transparent background and no text-align all others inherit the bodystyle, which defaults to a light gray background and centered text:.

Other

 * state
 * Variables = . The default is set 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.
 * 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 = 


 * 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 | will make the template expanded when viewing the template page by itself.


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