Template:Navbox/documentation

This template is used to create horizontal navigation templates.

How to Use it
For now, the English names of the parameters and some of their possible values are used. Their meanings are explained in this documentation.



List of parameters
All parameters in this template are lowercase. The required parameters are title and heading. If other parameters are omitted, a one-line navigation template is created.

Note that the group1 and other parameters are optional. Similarly, the above and under parameters are optional.

The basic and most used parameters are as follows (see below for a complete list):


 * navigation template name.
 * heading, text in the header of the navigation template. For example:.


 * image on the right side of the navigation template, for example . Don't forget a concise caption for the image.
 * image on the left side of the navigation template.


 * Text that appears above the groups and lists section, for example a list of some general wikilinks.


 * An enumeration with the number n. Usually contains a list of terms separated by a dot (•).
 * for example
 * Text on the left side before the enumeration with the number n. If omitted, the enumeration starts on the far left.


 * The text that appears underparts with groups and enumerations.

Further details and limitations are explained in the ParameterDescription section. Other possible layouts are in the Layout section.

Parameter description
This section contains the full list of template parameters. In most cases it is only necessary to fill in the parameters,   and.

Common settings

 * title (title)
 * border (frame)


 * If this parameter is set to  (nothing), the navigation template can be used inside some other container (for example, a general table).
 * If this parameter is set to any other value, the result will be the default behavior, i.e. the nav template will have a border with a space.

Individual parts

 * heading (heading)
 * the heading is the text that appears in the header of the entire template. It is usually a sufficient description of the template content. The heading is usually one line.
 * Technically, this parameter is not mandatory, but without it, the navigation template is meaningless. (Listingn)
 * The description refers to a number of parameters whose title differs only by a number, i.e. list1, list2, etc...; n can be at most 20.
 * The values of these parameters are the body of the template itself, usually a list of some items, usually links. It is necessary to include at least one list parameter for the template to have any content. Each additional list is another row of the table. For each listn there may be a parameter groupn, see below.


 * groupn (groupn)
 * The description refers to a series of parameters whose title differs only by a number, i.e. group1, group2, etc...; n can be at most 20.
 * If any of these parameters are filled, a cell describing the enumeration is displayed to the left of the enumeration. If this parameter is omitted for the enumeration, the enumeration is displayed across the full width of the navigation template.


 * image (image)
 * The parameter value is a reference to the image that appears to the right of the enumerations. The list1 parameter must be defined for the image to be displayed correctly.
 * The parameter can contain ordinary wikicode, for example
 * Don't forget the picture description, it is an important part of the picture.
 * Don't forget the picture description, it is an important part of the picture.


 * imageleft (left image)
 * The parameter value is a link to the image that appears to the left of the lists and groups. The list1 parameter must be defined for the image to be displayed correctly.
 * The parameter can contain common wikicode, for example
 * Don't forget the picture description, it is an important part of the picture.
 * Don't forget the picture description, it is an important part of the picture.


 * above (above)
 * This parameter can be used to create the initial item of the navigation template above all groups, lists and images. It can be useful for underwriting or quoting the content of the template itself. Its text will be displayed across the full width of the navigation template.


 * under (under)
 * This parameter can be used to create the end item (footer) of the navigation template under all groups, lists and images. It can be useful for explanations or notes on the content of the template itself. Its text will be displayed across the full width of the navigation template.

Advanced parameters

 * evenodd (even odd )
 * If the value of this parameter is  (swap), swapping the styles of even and odd enumerations. Usually, the even ones are a bit darker, this value will make them lighter.
 * If the value of this parameter is  (even) or   (odd), all enumerations will have a background as even or odd enumerations, respectively.

Layout
This section provides examples of the basic options that the user of this template has when selecting its elements.

Navbox with parameters image, above and under:

Navbox with parameters image, above and under:

Navbox with parameters image, imageleft, list and without group, above, under:

Without an image


With an image, without groups


With two images, without groups, with two lists


With an image, groups, above and under


Embedded navboxes
The navigation template can contain embedded navboxes. For a nested navbox, you need to define the first unnamed parameter as „ “ (descendant). The simple code can then look like this:



Example of an embedded navbox
In this section you will find examples with embedded navboxes. Note that the evenodd (even odd) parameter is used to swap the bars in some nested navboxes.



Source and technical details

 * This template including most of the documentation was taken from the Czech Wikipedia 9.8.2014, see original here.
 * You can see the CSS classes that define the navbox appearance at MediaWiki:common.css