Template:Navbox/doc

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.

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.

Images and groups have restrictions explained below under Parameter descriptions, where another parameter ("imageleft" ) can replace all group-cells.

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

The concise list of parameters is as follows:


 * the name of the template.
 * text in the title bar, such as: Widget stuff.
 * , or  (the status of box expansion,
 * where "autocollapse" hides stacked navboxes; "plain" removes the "[hide]" button).


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


 * an optional right-side image (coded as the whole image tag: [[Image:XX.jpg|90px]] ).
 * an optional left-side image, replacing group-cells (coded as the whole image tag).


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


 * the left-side text before list-n (if group-n omitted, list-n starts at left of box).
 * text listing wikilinks, often separated by middot templates, such as: [ [A]] [ [B]]
 * optional text to appear below the group/list section.
 * title-bar nav link (default:  for v • d • e links; "navbar=plain" will omit, but should only be used when absolutely necessary).

Further details, and complex restrictions, are explained below under section Parameter descriptions. See some alternate navbox formats under: Layout of table.

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.


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

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.


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


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


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

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


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


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


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

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 liststyle and oddstyle are transparent odd lists have the color of the bodystyle, which defaults to white. A list has  if it has a group, if not it has. Since only bodystyle has a vertical-align all the others inherit its.

Other

 * state  or
 * 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.
 * If set to blank or anything other than,   or   (such as "show"), 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 "show" inside &lt;noinclude> tags:
 * show autocollapse
 * That double 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 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 v • d • e links on the left side of the titlebar will not be displayed. Currently, however, the title will also no longer be centered. See  below for a workaround.

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:

Title centering
If the either the navbar (the v • d • e links) or the [show]/[hide] are disabled, then the title is not centered:

This can be resolved by padding the title with on the right or left:

Note that omitting both the [show]/[hide] link and the navbar has no effect on the title centering, as follows:

Technical details
Internally this meta template uses HTML markup instead of wiki markup for the table code. That is the usual way we make meta templates since wiki markup has several drawbacks. For instance it makes it harder to use parser functions and special characters in parameters.

Parser functions are used for calculations.

For more technical details see the |talk page, the CSS classes in MediaWiki:common.css and the collapsible table used to hide the box in MediaWiki:common.js