Template:Navbox/doc

This template allows a navigational template to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.

Full documentation and examples are at Template:Navbox.

Caution: Navboxes and other templates using the  or   attributes are not displayed in Mobile view.

Usage
Please remove the parameters that are left blank.



Parameter list
The navbox uses lowercase parameter names, as shown in the box (at right). The mandatory name and title will create a one-line box if other parameters are omitted.

Notice "group1" (etc.) is optional, as are sections named "above/below".

The basic and most common parameters are as follows (see below for the full list):


 * the name of the template.
 * text in the title bar, such as: Widget stuff.
 * a CSS class for the list cells, usually  for horizontal lists. Alternatively, use bodyclass for the whole box.
 * controls when a navbox is expanded or collapsed.


 * a CSS style for the title-bar, such as:
 * a CSS style for the group-cells, such as:


 * text to appear above the group/list section (could be a list of overall wikilinks).


 * an optional right-side image, coded as the whole image. Typically it is purely decorative, so it should be coded as.
 * an optional left-side image (code the same as the "image" parameter).


 * the left-side text before list-n (if group-n omitted, list-n starts at left of box).
 * text listing wikilinks using a wikilist format.
 * optional text to appear below the group/list section.

Parameter descriptions
The following is a complete list of parameters for using Navbox. In most cases, the only required parameters are,  , and  , though child navboxes do not even require those to be set.

Navbox shares numerous common parameter names with its sister templates, Navbox with columns and Navbox with collapsible groups, for consistency and ease of use. Parameters marked with an asterisk (*) are common to all three master templates.

Setup parameters

 * name*
 * The name of the template, which is needed for the "V • T • E" ("View • Talk • Edit") links to work properly on all pages where the template is used. You can enter  for this value as a shortcut.  The name parameter is only mandatory if a   is specified, and the   parameter is not set.


 * state* [ ]
 * Defaults to . A navbox with   will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see MediaWiki:Common.js.
 * If set to, the navbox will always start out in a collapsed state.
 * If set to, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the V • T • E links).
 * If set to, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered.  This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
 * If set to anything other than,  ,  , or   (such as "uncollapsed"), the navbox will always start out in an expanded state, but have the "hide" button.


 * To show the box when standalone (non-included) but then auto-hide contents when in an article, put "uncollapsed" inside &lt;noinclude> tags:
 * uncollapsed
 * That setting will force the box visible when standalone (even when followed by other boxes), displaying "[hide]" but then auto-collapse the box when stacked inside an article.


 * Often times, editors will want a default initial state for a navbox, 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:
 * The | will make the template expanded when viewing the template page by itself.
 * The | will make the template expanded when viewing the template page by itself.


 * Example: peso with autocollapse as the default initial state. Catalan peseta transcludes it and has only one navbox. So the peso navbox shows. Chilean peso has two navboxes. So the peso navbox collapses.
 * Example: wikipedia: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 template Collapsible option can be added to a section after the template definition to explain how to use the  parameter.


 * navbar*
 * If set to, the V • T • E links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered.  Use   to remove the V • T • E links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.


 * border*
 * See section hereafter on using navboxes within one another for examples and a more complete description. If set to  or , then the navbox can be used as a borderless child that fits snugly in another navbox.  The border is hidden and there is no padding on the sides of the table, so it fits into the list area of its parent navbox. If set to  , then the border is hidden and padding is removed, and the navbox may be used as a child of another container (do not use the   option inside of another navbox; similarly, only use the  /  option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the named border parameter):

Cells

 * 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.  This parameter is technically not mandatory, but using Navbox is rather pointless without a title.


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


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


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


 * 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, e.g.:
 * nb: including "|right" will produced the usual left margin to provide separation from the list items and zebra striping.
 * nb: including "|right" will produced the usual left margin to provide separation from the list items and zebra striping.


 * 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. It accepts the same sort of parameter that image accepts.


 * 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 listn parameter without a groupn parameter. For an example of the below parameter in use, see version of Lists of the provinces and territories of Canada.

Style parameters
Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.


 * style*
 * Specifies CSS styles to apply to the template body. The parameter bodystyle also does the exact same thing and can be used in place of this style parameter. This option should be used sparingly as it can lead to visual inconsistencies. Examples:


 * basestyle*
 * CSS styles to apply to the title, above, below, and group cells all at once. The styles are not applied to list cells.  This is convenient for easily changing the basic color of the navbox without having to repeat the style specifications for the different parts of the navbox.  Examples:


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


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


 * groupnstyle*
 * CSS styles to apply to a specific group, in addition to any styles specified by the groupstyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity.  Examples:


 * groupwidth
 * A number and unit specifying a uniform width for the group cells, in cases where little content in the list cells may cause group cells to be too wide. No default. However, may be overridden by the group(n)style parameter. Examples:


 * liststyle*
 * CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) hereafter. When using backgound colors in the navbox, see the note hereafter.


 * listnstyle*
 * CSS styles to apply to a specific list, in addition to any styles specified by the liststyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:


 * listpadding*
 * A number and unit specifying the padding in each list cell. The list cells come equipped with a default padding of 0.25em on the left and right, and 0 on the top and bottom. Due to complex technical reasons, simply setting "liststyle = padding: 0.5em;" (or any other padding setting) will not work. Examples:
 * (sets 0.5em padding for the left/right, and 0 padding for the top/bottom.)
 * (removes all list padding.)


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


 * evenodd
 * If set to, then the automatic striping of even and odd rows is reversed.  Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to   or   sets all rows to have that striping color. Setting to   disables automatic row striping. This advanced parameter should only be used to fix problems when the navbox is being used as a child of another navbox and the stripes do not match up.  Examples and a further description can be found in the section on child navboxes below.


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


 * imagestyle*
 * imageleftstyle*
 * CSS styles to apply to the cells where the image/imageleft sits. These styles should only be used in exceptional circumstances, usually to fix width problems if the width of groups is set and the width of the image cell grows too large. Examples:

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. Most styles are set in MediaWiki:Common.css.



Since liststyle and oddstyle are transparent, odd lists have the color of the bodystyle, which defaults to #fdfdfd (white with a hint of gray). A list defaults to  if it has a group, if not it defaults to. Since only bodystyle has a vertical-align all the others inherit its.

Advanced parameters

 * bodyclass
 * aboveclass
 * groupclass
 * listclass
 * belowclass
 * This enables attaching a CSS class to group or list cells. The most common use for listclass is to give it the  class that will cause lists to render horizontally. All these parameters accept the   class, but if more than one parameter is used for , use hlist instead.


 * titlegroup
 * This puts a group in the title area, with the same default styles as groupn. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of Navbox; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.


 * titlegroupstyle
 * The styles for the titlegroup cell.


 * innerstyle
 * A very advanced parameter to be used only for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). The style/bodystyle parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.

Microformats

 * bodyclass
 * This parameter is inserted into the "class" attribute for the navbox as a whole.


 * titleclass
 * This parameter is inserted into the "class" attribute for the navbox's title caption.

This template supports the addition of microformat information. This is done by adding "class" attributes to various data cells, indicating what kind of information is contained within. To flag a navbox as containing hCard information about a person, for example, add the following parameter:


 * bodyclass = vcard

and


 * titleclass = fn

or (for example):


 * title = The books of Iain Banks

...and so forth.

See WikiProject Microformats for more information on adding microformat information to Wikipedia, and microformat for more information on microformats in general.

Layout of table
Table generated by Navbox without image, above and below parameters (gray list background color added for illustration only):

Table generated by Navbox with image, above and below parameters (gray list background color added for illustration only):

Table generated by Navbox with image, imageleft, lists, and without groups, above, below (gray list background color added for illustration only):