Difference between revisions of "Template:Navbox with columns/doc"

Revision as of 08:33, 2 May 2008

Template:Template doc page viewed directly 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 = 
|colwidth =  <!--(to set a default width for each column,
                  preferably in a proportional unit such as 'em'*)-->
|col1  = 
|col2  = 
}}

Parameters

Required parameters in bold. Parameters marked with a cross^† are parameters in common with the sister template {{Navbox}}. A much more complete description of those parameters is available there.

Setup parameters

name^†

The name of the template. The name of this template, for example, is "Navigation 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 sections}}. 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

bodystyle^†

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, below, and group 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

colsstyle

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.

colheader2style

CSS style/s to apply to all second level columns headers.

col_nheaderstyle

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

col_nheaderstyle2

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

col_nfooter

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%

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. col1 is required. There can be a maximum of 12 columns.

col_nheader

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

col_nheader2

A second header cell for the n^th column that appears above the column, but below the first header cell.

col_nfooter

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

Customization parameters for the column headers and footer

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_nheaderrowspan

Set to either 1 or 2; defaults to 1. The number of rows that the n^th column header should span. Only set to two if you intend to set colNheader2 for the remaining columns.

col_nheader2colspan

A number specifying how many columns the n^th second level 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 col1header2colspan = 3, then leave col2header2 and col3header3 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 col1footerspan = 3, then leave col2footer and col3footer blank.

Additional groups/lists

You may wish to add a few extra 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. Groups are not allowed.

list_n

Allows up to 6 additional lists below the columns.

liststyle

The general CSS style/s for the lists.

list_nstyle

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

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/> {{CAM}}<br/> {{IND}}
|col2 = {{IDN}}<br/> {{JPN}}<br/> {{LAO}}<br/> {{MAS}}
|col3 = {{MYA}}<br/> {{NZL}}<br/> {{CHN-PRC}}<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)
}}

Example with col_nheader and col_nfooter

The gray background for the columns is added for illustration only.

Advanced col_nheader example

This example shows how to use the col_nheaderrowspan and col_nheadercolspan features to make the headers look the way you want. This one uses both header levels. The gray background for the columns is added for illustration only.

Using child navboxes

All three types of navbox templates, namely {{Navbox}}, {{Navbox with columns}}, and {{Navbox with collapsible sections}}, can be nested inside of one another using the border parameter (which is common to all three). For complex templates, it may be necessary to use nesting to achieve a desired look.

Nesting Navbox with columns in itself

This example shows how one can nest multiple {{Navbox with columns}} templates to get the right look. Edit this section to view the code. There is a main {{Navbox with columns}} and two additional {{Navbox with columns}} templates, with the "child" option set (see code).

Nesting other Navbox forms

This example shows {{Navbox}}, {{Navbox with collapsible sections}} and {{Navbox with columns}} all working together. Press the edit button for the section to view the code. Note that each of the child navboxes has the first parameter set to child User:CapitalR/Navbox with collapsible sections

See also

• {{Navbox}} – Allows groups/lists instead of columns
• {{Navbox with collapsible sections}} – Another variation.

Template:Navigational templates