Template:Navbox with columns/doc

Navbox suite
{{Navbox}} {{Navbox subgroup}} {{Navbox with collapsible groups}} {{Navbox with columns}} {{Navboxes}}

A navigation box that presents its content in columns. Originally intended to provide a relatively straightforward means to align links prefixed by flag icons, e.g. in templates offering links to country articles.

Basic syntax

Only required parameters and colwidth included.

{{Navbox with columns
|name       = {{subst:PAGENAME}}
|title      = 
|titleclass = 
|bodyclass  = 
|colwidth =  <!--(to set a default width for each column,
                  preferably in a proportional unit such as 'em'*)-->
|col1  = 
|col2  = 
}}

* Using proportional units means the template should still be displayed correctly across a range of browser font-sizes. If colwidth not specified, a default 10em is used.

Parameters

Setup parameters

name

The name of the template. The name of this template, for example, is "Navbox with columns".

state

Possible values are collapsed, uncollapsed, plain, off, and the default autocollapse. See {{Navbox}} for more information.

navbar

Possible values are plain, off, and the default value of blank. See {{Navbox}} for more information.

border

Possible values are child, none, and the default value of blank. Set to child if you wish to use the navbox inside of another navbox; with this option, the child navbox is borderless and fits snuggly inside of its parent navbox. The parent navbox may be the list area of {{Navbox}}, a columns of another {{Navbox with columns}}, or a section of {{Navbox with collapsible groups}}. See {{Navbox}} for more information and examples.

Basic data parameters

title

The title of the template, displayed centered in the titlebar at the top of the template.

above

Text or other elements to appear above the columns.

image

Image to the right of all of the columns.

imageleft

Image to the left of all of the columns.

below

Text or other elements to appear below the columns.

Style parameters

style

CSS style/s to apply to the template's body (i.e. including space not used by columns)

titlestyle

CSS style/s to apply to titlebar; usually background:color (background defaults to NavHead default).

abovestyle

belowstyle

CSS style/s to apply to the above and below parameters, respectively.

basestyle

CSS style/s to apply to the title, above, and below, parameters, all at the same time.

imagestyle

CSS style/s to apply to the image parameter.

imageleftstyle

CSS style/s to apply to the imageleft parameter

colstyle

CSS style/s to apply across all columns; if used, usually background:color per titlestyle above.

oddcolstyle

evencolstyle

CSS style/s to apply to all odd/even-numbered columns, respectively.

col_nstyle

CSS style/s to apply to the n^th column only.

colheaderstyle

CSS style/s to apply to all column headers.

col_nheaderstyle

CSS style/s to apply to the n^th column header.

col_nfooterstyle

CSS style/s to apply to the n^th column footer cell.

Columns parameters

colwidth

Width, preferably in a proportional unit such as 'em', or as a percentage, used for each column whose width not specified by colNwidth below. Defaults to 10em. Examples:

colwidth = 15em

colwidth = 25%

fullwidth

If set to anything, then the total width of the columns are scaled linearly to make the sum of the widths 100%. A rather advanced parameter, this usually need not be used and should be left blank. If a colheader or colfooter is used, then fullwidth is used automatically. Example:

fullwidth = true

padding

Padding before first column, preferably in a proportional unit. Defaults to 5em. Padding is disabled by setting it to 0 (or 0em, or 0%).

col_nwidth

The n^th column's width (overrides colwidth above).

col_n

The content of the n^th column. If any columns are used, then col1 is required. There can be a maximum of 20 columns.

col_nheader

A header cell for the n^th column that appears above the column. See below for examples.

col_nfooter

A footer cell that appears below the n^th column.

col_nheadercolspan

A number specifying how many columns the n^th column header should span. It defaults to 1. If it is greater than one, then do not specify column headers that it covers. For example, if col1headercolspan = 3, then leave col2header and col3header blank.

col_nfootercolspan

A number specifying how many columns the n^th column footer should span. It defaults to 1. If it is greater than one, then do not specify column footers that it covers. For example, if col1footercolspan = 3, then leave col2footer and col3footer blank.

Additional groups/lists

You may wish to add a few extra groups and/or lists below the columns. The following parameters are given to provide such functionality. See {{Navbox}} for a more complete description of how they work, and for more examples.

group_n

Allows up to 6 additional groups to go along with the lists below the columns.

list_n

Allows up to 6 additional lists below the columns.

groupstyle

The general CSS style/s for the groups.

group_nstyle^†

CSS style/s for the n^th group parameter.

liststyle

The general CSS style/s for the lists.

list_nstyle

CSS style/s for the n^th list parameter.

listpadding

Amount of padding to have in each list cell.

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 [swap, even, odd, off]

See {{Navbox}} for description.

Microformats

bodyclass

This parameter is inserted into the "class" attribute for the infobox as a whole.

titleclass

This parameter is inserted into the "class" attribute for the infobox'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 <span class="fn">[[Iain Banks]]</span>

...and so forth.

Examples

Basic example

{{Navbox with columns
|name    = East Asia Summit (EAS)
|title   = Member states of the [[East Asia Summit|East Asia Summit (EAS)]]
|width   = 18.25em
|padding = 10em

|above = ''This is where the {{{above}}} would appear.''

|col1 = {{AUS}}<br> {{BRU}}<br> {{flag|CHN|name=PR China}}<br> {{CAM}}
|col2 = {{IND}}<br> {{IDN}}<br> {{JPN}}<br> {{LAO}}
|col3 = {{MAS}}<br> {{MMR}}<br> {{NZL}}<br> {{PHI}}
|col4width = 17em
|col4 = {{SIN}}<br> {{KOR}}<br> {{THA}}<br> {{VIE}}

|below = '''Potential future members'''{{spaces|6}}{{TLS}}{{spaces|3}}{{RUS}}
}}

Example with percentage widths

{{Navbox with columns
| name = Plastics
| title = [[Plastic]]s
| colwidth = 33%
| colstyle = text-align: center
| col1 = [[Polyethylene]] (PE)<br> [[Polyethylene terephthalate]] (PET or PETE)<br> [[Polyvinyl chloride]] (PVC)<br> [[Polyvinylidene chloride]] (PVDC)<br> [[Polylactic acid]] (PLA)
| col2 = [[Polypropylene]] (PP)<br> [[Polyamide]] (PA)<br> [[Polycarbonate]] (PC)<br> [[Polytetrafluoroethylene]] (PTFE)<br> [[Polyurethane]] (PU)
| col3 = [[Polystyrene]] (PS)<br> [[Polyester]]<br> [[Acrylonitrile butadiene styrene]] (ABS)<br> [[Acrylic glass|Polymethyl methacrylate]] (PMMA)<br> [[Polyoxymethylene]] (POM)
}}

See also

Navigation templates comparison

	Collapsible	Header color	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{[[Template:|]]}} {{[[Template:|]]}}
{{Navbox with collapsible groups}}	collapsible	navbox	Left/right of body and/or in each list	Yes	Yes	{{[[Template:|]]}} {{[[Template:|]]}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{[[Template:|]]}} {{[[Template:|]]}}
{{Navbox years}}	collapsible	navbox	No	No	No	{{[[Template:|]]}}

Collapsible attributes

Type	CSS classes	Javascript	Collapses when	Custom initial state	Nesting
Collapsible tables	collapsible	Defined in Common.js	2 or more autocollapse on page	Yes	Yes