Parameter descriptions

The following is a complete list of parameters for using {{Navboks}}. In most cases, the only required parameters are navn, titel, and liste1, though child navboxes do not even require those to be set.

Setup parameters

navn†

The navn 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 {{subst:PAGENAME}} for this value as a shortcut. The navn parameter is only mandatory if a titel is specified, and the ramme parameter is not set.

status†[autocollapse, uncollapsed, collapsed, plain, off]

Defaults to autocollapse. A Navboks with autocollapse will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the Navboks will be expanded. For the technically minded, see MediaWiki:Common.js.

If set to collapsed, the Navboks will always start out in a collapsed status.

If set to plain, the Navboks will always be expanded with no [hide] link on the right, and the titel will remain centered (by using padding to offset the v • d • e links).

If set to off, the Navboks will always be expanded with no [hide] link on the right, but no padding will be used to keep the titel 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 autocollapse, collapsed, plain, or off (such as "uncollapsed"), the Navboks will always start out in an expanded status, 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 <noinclude> tags:

status = <noinclude>uncollapsed</noinclude>

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 status for a Navboks, which may be overridden in an article. Here is the trick to do this:

In your intermediate template, create a parameter also named "status" as a pass-through like this:

The <includeonly>| will make the template expanded when viewing the template page by itself.

Example: {{peso}} with autocollapse as the default initial status. Bolivian peso transcludes it and has only one Navboks. So the peso Navboks shows. Chilean peso has two navboxes. So the peso Navboks collapses.

Example: {{Historical currencies of Hungary}} with expanded as the default initial status. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies status = collapsed when transcluding.

navbar†

Defaults to Tnavbar. If set to plain, the v • d • e links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the titel centered. Use off to remove the v • d • 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). Note that it is highly recommended that one does not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.

ramme†

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

{{Navboks|child

...

}}

Cells

titel†

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 {{Navboks}} is rather pointless without a titel.

groupn†

(i.e. gruppe1, gruppe2, 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. liste1, liste2, 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 <div> </div>. 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 under).

billede†

An billede to be displayed in a cell under the titel and to the right of the body (the groups/lists). For the billede to display properly, the liste1 parameter must be specified. The billede parameter accepts standard wikicode for displaying an billede, i.e.

billede = [[billede:Example.jpg|100px]]

billede-venstre†

An billede to be displayed in a cell under the titel and to the left of the body (lists). For the billede to display properly, the liste1 parameter must be specified and no groups can be specified. The billede-venstre parameter accepts standard wikicode for displaying an billede, i.e.

billede-venstre = [[billede:Example.jpg|100px]]

over†

A full-width cell displayed between the titlebar and first group/list, i.e. over the template's body (groups, lists and billede). In a template without an billede, over behaves in the same way as the liste1 parameter without the gruppe1 parameter.

under†

A full-width cell displayed under the template's body (groups, lists and billede). In a template without an billede, under behaves in the same way as the template's final listn parameter without a groupn parameter. For an example of the under parameter in use, see {{Lists of the provinces and territories of Canada}}.

Style parameters

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

style†

Specifies CSS styles to apply to the template body. The parameter body-style also does the example 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:

style = background:#nnnnnn;

style = width:N [em/%/px or width:auto];

style = float:[left/right/none];

style = clear:[right/left/both/none];

grund-style†

CSS styles to apply to the titel, over, under, and group cells all at once. The style are not applied to list cells. This is convenient for easily changing the basic color of the Navboks without having to repeat the style specifications for the different parts of the Navboks. Examples:

grund-style = background:lightskyblue;

titel-style†

CSS styles to apply to titel, most often the titlebar's background color:

titel-style = background:#nnnnnn;

titel-style = background:navn;

gruppe-style†

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

gruppe-style = background:#nnnnnn;

gruppe-style = text-align:[left/center/right];

gruppe-style = vertical-align:[top/middle/bottom];

groupnstyle†

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

gruppe3-style = background:red;color:white;

liste-style†

CSS styles to apply to all lists. Overruled by the ulige-style and lige-style parameters (if specified) under.

listnstyle†

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

liste5-style = background:#ddddff;

liste-padding†

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 0em on the top and bottom. Due to complex technical reasons, simply setting "liste-style=padding:0.5em;" (or any other padding setting) will not work. Examples:

liste-padding = 0.5em 0em; (sets 0.5em padding for the left/right, and 0em padding for the top/bottom.)

liste-padding = 0em; (removes all list padding.)

ulige-style

lige-style

Applies to odd/even list numbers. Overrules styles defined by liste-style. 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.

lige-ulige[swap, even, odd, off]

If set to swap, 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 even or odd sets all rows to have that striping color. Setting to off disables automatic row striping. This advanced parameter should only be used to fix problems when the Navboks is being used as a child of another Navboks and the stripes do not match up. Examples and a further description can be found in the section on child navboxes under.

over-style†

under-style†

CSS styles to apply to the top cell (specified via the over parameter) and bottom cell (specified via the under parameter). Typically used to set background color or text alignment:

over-style = background:#nnnnnn;

over-style = text-align:[left/center/right];

billede-style†

billede-venstre-style†

CSS styles to apply to the cells where the billede/billede-venstre 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 billede cell grows too large. Examples:

billede-style = width:5em;

Default styles

The style settings listed here are those that editors using the Navboks 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 liste-style and ulige-style are transparent odd lists have the color of the body-style, which defaults to #fdfdfd (white with a hint of gray). A list has text-align:left; if it has a group, if not it has text-align:center;. Since only body-style has a vertical-align all the others inherit its vertical-align:middle;.

Advanced parameters

titel-gruppe

This puts a group in the titel 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 {{Navboks}}; 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.

titel-gruppe-style

The styles for the titel-gruppe cell.

indre-style

A very advanced parameter to be used only for advanced meta-templates employing the Navboks. Internally, the Navboks uses an outer table to draw the ramme, and then an inner table for everything else (titel/over/groups/lists/under/images, etc.). The style/body-style 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.

Child navboxes

It is possible to place multiple navboxes within a single ramme with the use of the ramme parameter, or by specifying the first parameter to be "child". The basic code for doing this is as follows (which adds a subgroup for the first group/list area):

Subgroups example

This example shows how subgroups can be used. It is recommended that one uses {{Navboks undergruppe}}, but the same result can be reached by using {{Navboks}} with ramme = child or the first unnamed parameter set to child. Note that the lige-ulige parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. If you wish to remove the striping altogether, you can set liste-style = background:transparent; in each of the navboxes.

Multiple show/hides in a single container

The example under is generated using a regular Navboks for the main container, then its liste1, liste2, and liste3 parameters each contain another Navboks, with ramme = child set. Note that each of the child navboxes has its own VDE navbar; these could be hidden using navbar = plain for each of them, or by just leaving out the navn parameter (child navboxes do not require the navn parameter to be set, unlike regular navboxes).

Additional examples

Relationship with other Navboks templates

This Navboks template is specifically designed to work in conjunction two other sister templates: {{Navboks with columns}} and {{Navboks with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with a † in the complete parameter list over). Most importantly, all three of these templates can each be used as children of one another (by using the ramme = child parameter, or by specifying the first unnamed parameter to be child (i.e. use {{Navboks|child, {{Navboks with columns|child, or {{Navboks with collapsible groups|child). For examples on how this is done, see the page on advanced Navboks examples.

Technical details

This template uses CSS classes for most of its looks, thus it is fully skinnable.

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.

Intricacies

The 2px wide ramme between groups and lists is drawn using the border-left property of the list cell. Thus, if you wish to change the background color of the template (for example body-style = background:purple;), then you'll need to make the border-left-color match the background color (i.e. liste-style = border-left-color:purple;). If you wish to have a ramme around each list cell, then the 2px ramme between the list cells and group cells will disappear; you'll have to come up with your own solution.

The list cell width is initially set to 100%. Thus, if you wish to manually set the width of group cells, you'll need to also specify the liste-style to have width:auto. If you wish to set the group width and use images, it's up to you to figure out the CSS in the gruppe-style, liste-style, billede-style, and billede-venstre-style parameters to get everything to work correctly. Example of setting group width:

gruppe-style = width:10em;

liste-style = width:auto;

Adjacent navboxes have only a 1 pixel ramme between them (except in IE6, which doesn't support the necessary CSS). If you set the top or bottom margin of style/body-style, then this will not work.

The default margin-left and margin-right of the outer Navboks table are set to "auto;". If you wish to use Navboks as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option. For example, add the following code to use the Navboks as a float: