View source for Template:Navbox with columns/doc

{{Documentation subpage}}
{{Template display|nomobile}}
{{Navbox suite}}

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.

<pre style="overflow:auto;">
{{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 = 
}}
</pre>
<div style="font-size:90%;line-height:1.35em;">* See [[Em (typography)]]. Using proportional units means the template should still be displayed correctly across a range of browser font-sizes. If ''colwidth'' is not specified, a default 10.0em is used.</div>

== Parameters ==

===Setup parameters===
;''name''<ref name="common">Parameters marked with a footnote '''<sup>[1]</sup>''' are parameters in common with the sister templates {{tl|Navbox}} and {{tl|Navbox with collapsible groups}}. A much more complete description of those parameters is available at {{tl|Navbox}}.</ref>
:The name of the template. The name of this template, for example, is "Navbox with columns".
;''state''<ref name="common"/>
:Possible values are <code>collapsed</code>, <code>uncollapsed</code>, <code>plain</code>, <code>off</code>, and the default <code>autocollapse</code>.  See {{tl|Navbox}} for more information.
;''navbar''<ref name="common"/>
:Possible values are <code>plain</code>, <code>off</code>, and the default value of blank.  See {{tl|Navbox}} for more information.
;''border''<ref name="common"/>
:Possible values are <code>child</code>, <code>none</code>, and the default value of blank.  Set to <code>child</code> 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 {{tl|Navbox}}, a columns of another {{tl|Navbox with columns}}, or a section of {{tl|Navbox with collapsible groups}}.  See {{tl|Navbox}} for more information and examples.

===Perimeter parameters===
i.e. parameters affecting the inclusion/formatting of items around the template's perimeter.

;''title''<ref name="common"/>
:The title of the template, displayed centered in the titlebar at the top of the template.
;''above''<ref name="common"/>
:Text or other elements to appear above the columns.
;''image''<ref name="common"/>
:Image to the right of all of the columns.
;''imageleft''<ref name="common"/>
:Image to the left of all of the columns.
;''below''<ref name="common"/>
:Text or other elements to appear below the columns.

===Style parameters===
;''style''<ref name="common"/>
:CSS style/s to apply to the template's body (i.e. including space not used by columns)
;''titlestyle''<ref name="common"/>
:[[Wikipedia:CSS|CSS]] style/s to apply to titlebar; usually <code>background:''color''</code> (background defaults to [[Wikipedia:Navbox|Navbox]] default).
;''abovestyle''<ref name="common"/>
;''belowstyle''<ref name="common"/>
:CSS style/s to apply to the ''above'' and ''below'' parameters, respectively.
;''basestyle''<ref name="common"/>
:CSS style/s to apply to the ''title'', ''above'', and ''below'', parameters, all at the same time.
;''imagestyle''<ref name="common"/>
:CSS style/s to apply to the ''image'' parameter.
;''imageleftstyle''<ref name="common"/>
:CSS style/s to apply to the ''imageleft'' parameter
;''coltablestyle''
;''colstyle''
:CSS style/s to apply across all columns; if used, usually <code>background:''color''</code> per ''titlestyle'' above.
;''oddcolstyle''
;''evencolstyle''
:CSS style/s to apply to all odd/even-numbered columns, respectively.
;''col<sub>n</sub>style''
:CSS style/s to apply to the n<sup>th</sup> column only.
;''colheaderstyle''
:CSS style/s to apply to all column headers.
;''col<sub>n</sub>headerstyle''
:CSS style/s to apply to the n<sup>th</sup> column header.
;''col<sub>n</sub>footerstyle''
:CSS style/s to apply to the n<sup>th</sup> column footer cell.

===Columns parameters===
;''colwidth''
:Width, preferably in a proportional unit such as '[[Em (typography)|em]]', or as a percentage, used for each column whose width not specified by ''colNwidth'' below. Defaults to 10em.  Examples:
:*<code>colwidth = 15.0em</code>
:*<code>colwidth = 25%</code>
:
;''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:
:*<code>fullwidth = on</code>
:
;''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<sub>n</sub>width''
:The n<sup>th</sup> column's width (overrides ''colwidth'' above).
;'''''col<sub>n</sub>'''''
:The content of the n<sup>th</sup> column.  If any columns are used, then <code>col1</code> is required.  There can be a maximum of 20 columns.
;''col<sub>n</sub>header''
:A header cell for the n<sup>th</sup> column that appears above the column.  See below for examples.
;''col<sub>n</sub>footer''
:A footer cell that appears below the n<sup>th</sup> column.
;''col<sub>n</sub>headercolspan''
:A number specifying how many columns the n<sup>th</sup> 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 <code>col1headercolspan = 3</code>, then leave <code>col2header</code> and <code>col3header</code> blank.
;''col<sub>n</sub>footercolspan''
:A number specifying how many columns the n<sup>th</sup> 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 <code>col1footercolspan = 3</code>, then leave <code>col2footer</code> and <code>col3footer</code> 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 {{tl|Navbox}} for a more complete description of how they work, and for more examples.

;''group<sub>n</sub>''<ref name="common"/>
:Allows up to 6 additional groups to go along with the lists below the columns.
;''list<sub>n</sub>''<ref name="common"/>
:Allows up to 6 additional lists below the columns.
;''groupstyle''<ref name="common"/>
:The general CSS style/s for the groups.
;''group<sub>n</sub>''style<sup>†</sup>
:CSS style/s for the n<sup>th</sup> group parameter.<ref name="common"/>
;''liststyle''<ref name="common"/>
:The general CSS style/s for the lists.
;''list<sub>n</sub>style''
:CSS style/s for the n<sup>th</sup> list parameter.
;''listpadding''<ref name="common"/>
: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'' <span style="font-weight:normal;"><code>[swap, even, odd, off]</code></span>
:See {{tl|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:

<pre>
|bodyclass = vcard
</pre>

''and''

<pre>
|titleclass = fn
</pre>

''or'' (for example):

<pre><nowiki>
|title = The books of <span class="fn">[[Iain Banks]]</span>
</nowiki></pre>

...and so forth.

See [[Wikipedia:WikiProject Microformats]] for more information on adding microformat information to Wikipedia, and [[microformat]] for more information on microformats in general.

== Examples ==
===Basic example===
<syntaxhighlight lang="moin" style="overflow:scroll;">
 {{Navbox with columns
 | name = East Asia Summit (EAS)
 | title = [[East Asia Summit|East Asia Summit (EAS)]]
 | listclass = plainlist
 | width = 18.25em
 | padding = 10em
 | aboveclass = hlist
 | abovestyle = font-weight: bold;

 | above =
 * [[First East Asia Summit|First]]
 * [[Second East Asia Summit|Second]]
 * [[Third East Asia Summit|Third]]
 * [[Fourth East Asia Summit|Fourth]]
 * [[Fifth East Asia Summit|Fifth]]
 * [[Sixth East Asia Summit|Sixth]]
 * [[Seventh East Asia Summit|Seventh]]

 | col1 =
 * {{AUS}}
 * {{BRU}}
 * {{BIR}}

 | col2 =
 * {{CAM}}
 * {{CHN}}
 * {{IND}}

 | col3 =
 * {{IDN}}
 * {{JPN}}
 * {{LAO}}

 | col4 =
 * {{MAS}}
 * {{NZL}}
 * {{PHL}}

 | col5 =
 * {{RUS}}
 * {{SIN}}
 * {{KOR}}

 | col6width = 17em
 | col6 =
 * {{THA}}
 * {{USA}}
 * {{VIE}}
 }}
</syntaxhighlight>
{{Navbox with columns
| name = East Asia Summit (EAS)
| title = [[East Asia Summit|East Asia Summit (EAS)]]
| state = uncollapsed
| listclass = plainlist
| width = 18.25em
| padding = 10em
| aboveclass = hlist
| abovestyle = font-weight: bold;

| above =
* [[First East Asia Summit|First]]
* [[Second East Asia Summit|Second]]
* [[Third East Asia Summit|Third]]
* [[Fourth East Asia Summit|Fourth]]
* [[Fifth East Asia Summit|Fifth]]
* [[Sixth East Asia Summit|Sixth]]
* [[Seventh East Asia Summit|Seventh]]

| col1 =
* {{AUS}}
* {{BRU}}
* {{BIR}}

| col2 =
* {{CAM}}
* {{CHN}}
* {{IND}}

| col3 =
* {{IDN}}
* {{JPN}}
* {{LAO}}

| col4 =
* {{MAS}}
* {{NZL}}
* {{PHL}}

| col5 =
* {{RUS}}
* {{SIN}}
* {{KOR}}

| col6width = 17em
| col6 =
* {{THA}}
* {{USA}}
* {{VIE}}
}}

===Example with percentage widths===
<syntaxhighlight lang="moin" style="overflow:scroll;">
 {{Navbox with columns
 | name = Transit visibility table
 | titlestyle = background:silver;
 | title = [[Astronomical transit|Transit]] visibility from [[inferior and superior planets|planets superior]] to the transiting body
 | listclass = plainlist
 | colwidth = 14.2857%
 | colstyle = text-align:center;

 | col1header = Venus
 | col1 = 
 * [[Transit of Mercury from Venus|Mercury]]

 | col2header = Earth
 | col2 = 
 * [[Transit of Mercury|Mercury]]
 * [[Transit of Venus|Venus]]

 | col3header = Mars
 | col3 = 
 * [[Transit of Mercury from Mars|Mercury]]
 * [[Transit of Venus from Mars|Venus]]
 * [[Transit of Earth from Mars|Earth]]

 | col4header = Jupiter
 | col4 =
 * [[Transit of Mercury from Jupiter|Mercury]]
 * [[Transit of Venus from Jupiter|Venus]]
 * [[Transit of Earth from Jupiter|Earth]]
 * [[Transit of Mars from Jupiter|Mars]]

 | col5header = Saturn
 | col5 = 
 * [[Transit of Mercury from Saturn|Mercury]]
 * [[Transit of Venus from Saturn|Venus]]
 * [[Transit of Earth from Saturn|Earth]]
 * [[Transit of Mars from Saturn|Mars]]
 * [[Transit of Jupiter from outer planets|Jupiter]]

 | col6header = Uranus
 | col6 = 
 * [[Transit of Mercury from Uranus|Mercury]]
 * [[Transit of Venus from Uranus|Venus]]
 * [[Transit of Earth from Uranus|Earth]]
 * [[Transit of Mars from Uranus|Mars]]
 * [[Transit of Jupiter from outer planets|Jupiter]]
 * [[Transit of Saturn from outer planets|Saturn]]

 | col7header = Neptune
 | col7 = 
 * [[Transit of Mercury from Neptune|Mercury]]
 * [[Transit of Venus from Neptune|Venus]]
 * [[Transit of Earth from Neptune|Earth]]
 * [[Transit of Mars from Neptune|Mars]]
 * [[Transit of Jupiter from outer planets|Jupiter]]
 * [[Transit of Saturn from outer planets|Saturn]]
 * [[Transit of Uranus from Neptune|Uranus]]
 }}
</syntaxhighlight>
{{Navbox with columns
| name = Transit visibility table
| titlestyle = background:silver;
| title = [[Astronomical transit|Transit]] visibility from [[inferior and superior planets|planets superior]] to the transiting body
| state = uncollapsed
| listclass = plainlist
| colwidth = 14.2857%
| colstyle = text-align:center;

| col1header = Venus
| col1 = 
* [[Transit of Mercury from Venus|Mercury]]

| col2header = Earth
| col2 = 
* [[Transit of Mercury|Mercury]]
* [[Transit of Venus|Venus]]

| col3header = Mars
| col3 = 
* [[Transit of Mercury from Mars|Mercury]]
* [[Transit of Venus from Mars|Venus]]
* [[Transit of Earth from Mars|Earth]]

| col4header = Jupiter
| col4 =
* [[Transit of Mercury from Jupiter|Mercury]]
* [[Transit of Venus from Jupiter|Venus]]
* [[Transit of Earth from Jupiter|Earth]]
* [[Transit of Mars from Jupiter|Mars]]

| col5header = Saturn
| col5 = 
* [[Transit of Mercury from Saturn|Mercury]]
* [[Transit of Venus from Saturn|Venus]]
* [[Transit of Earth from Saturn|Earth]]
* [[Transit of Mars from Saturn|Mars]]
* [[Transit of Jupiter from outer planets|Jupiter]]

| col6header = Uranus
| col6 = 
* [[Transit of Mercury from Uranus|Mercury]]
* [[Transit of Venus from Uranus|Venus]]
* [[Transit of Earth from Uranus|Earth]]
* [[Transit of Mars from Uranus|Mars]]
* [[Transit of Jupiter from outer planets|Jupiter]]
* [[Transit of Saturn from outer planets|Saturn]]

| col7header = Neptune
| col7 = 
* [[Transit of Mercury from Neptune|Mercury]]
* [[Transit of Venus from Neptune|Venus]]
* [[Transit of Earth from Neptune|Earth]]
* [[Transit of Mars from Neptune|Mars]]
* [[Transit of Jupiter from outer planets|Jupiter]]
* [[Transit of Saturn from outer planets|Saturn]]
* [[Transit of Uranus from Neptune|Uranus]]
}}

===Example with col<sub>n</sub>header and col<sub>n</sub>footer===
The gray background for the columns is added for illustration only.
{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = col<sub>n</sub>header and col<sub>n</sub>footer example

|colstyle = text-align:center;background:silver;
|colwidth = 25%

|col1header = col1header
|col2header = col2header
|col3header = col3header
|col4header = col4header

|col1 = col1
|col2 = col2
|col3 = col3
|col4 = col4

|col1footer = col1footer
|col2footer = col2footer
|col3footer = col3footer
|col4footer = col4footer

}}

===Example with col<sub>n</sub>header using col<sub>n</sub>headercolspan===
The gray background for the columns is added for illustration only.  This example shows the col<sub>n</sub>headercolspan parameter being used, but you may also use col<sub>n</sub>footercolspan to adjust the span of the footer cells.
{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = col<sub>n</sub>header with col<sub>n</sub>colspan example

|colstyle = text-align:center;background:silver;

|col1header = col1header
|col2header = col2header (colspan=2)
|col4header = col4header
|col5header = col5header (colspan=3)

|col2headercolspan = 2
|col5headercolspan = 3

|col1 = col1
|col2 = col2
|col3 = col3
|col4 = col4
|col5 = col5
|col6 = col6
|col7 = col7
}}

===Example to illustrate most fields===
The gray background and centered text for the columns is for illustration only.  The columns default to an off-white background and left text alignment.  This example shows how you can use up to six additional groups/lists after the columns.

{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = Example to illustrate most fields
|colstyle = text-align:center;background:silver;

|col1 = col1
|col2 = col2
|col3 = col3
|col4 = col4
|col5 = col5

|col1header = col1header
|col2header = col2header
|col3header = col3header
|col4header = col4header
|col5header = col5header

|col1footer = col1footer
|col2footer = col2footer
|col3footer = col3footer
|col4footer = col4footer
|col5footer = col5footer

|group1 = group1
|group2 = group2
|group3 = group3
|group4 = group4
|group5 = group5
|group6 = group6

|list1 = list1
|list2 = list2
|list3 = list3
|list4 = list4
|list5 = list5
|list6 = list6

|above = above
|below = below
}}

==Using child navboxes==
All three types of navbox templates, namely {{tl|Navbox}}, {{tl|Navbox with columns}}, and {{tl|Navbox with collapsible groups}}, can be nested inside of one another using the <code>border</code> 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 {{tl|Navbox with columns}} templates to get the right look.  Edit this page to see the code.  There is a main {{tl|Navbox with columns}} and two additional {{tl|Navbox with columns}} templates, with the "child" option set (see code).
{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = Subgroups with nesting
|colstyle = text-align:center;background:silver;

|col1width = 33%
|col2width = 17%
|col3width = 33%
|col4width = 17%

|col1header = Col1Header
|col2header = Col2Header
|col3header = Col3Header
|col4header = Col4Header

|col1 = {{Navbox with columns|child
  |colwidth = 50%
  |colstyle = text-align:center;background:silver;

  |col1header = Col1.1Header
  |col2header = Col1.2Header

  |col1 = Col1.1
  |col2 = Col1.2
 }}

|col2 = Col2

|col3 = {{Navbox with columns|child
  |colwidth = 33%
  |colstyle = text-align:center;background:silver;

  |col1header = Col3.1Header
  |col2header = Col3.2Header
  |col3header = Col3.3Header

  |col1 = Col3.1
  |col2 = Col3.2
  |col3 = Col3.3
 }}

|col4 = Col4
}}

===Nesting other Navbox forms===
This example shows {{tl|Navbox}}, {{tl|Navbox with collapsible groups}} and {{tl|Navbox with columns}} all working together.  Edit this page to see the code.  Note that each of the child navboxes has the first parameter set to <code>child</code>.
{{Navbox with collapsible groups
|name = Navbox with collapsible groups
|title = Navbox, Navbox with columns, and Navbox with collapsible groups together
|selected = {{{1|}}}

|group1 = [[:Category:Scouting|The Scouting Movement]]
|abbr1  = movement
|list1  = [[Scouting]]{{·}}''[[Scouting for Boys]]''{{·}}[[Scout method]]{{·}}[[Scout Law]]{{·}}[[Scout Promise]]{{·}}[[Scout Motto]]{{·}}[[Wood Badge]]{{·}}[[Age groups in Scouting and Guiding]]{{·}}[[Cub Scout]]{{·}}[[Boy Scout]]{{·}}[[Rover Scout]]{{·}}[[Brownie (Girl Guides)|Brownie]]{{·}}[[Girl Guiding and Girl Scouting]]{{·}}[[Ranger (Girl Guide)]]{{·}}[[Jamboree (Scouting)|Jamboree]]{{·}}[[Scout Leader]]{{·}}[[World Organization of the Scout Movement|WOSM]]{{·}}[[World Association of Girl Guides and Girl Scouts|WAGGGS]]{{·}}[[Non-aligned Scouting and Scout-like organisations|Non-aligned organisations]]{{·}}[[Scouting controversy and conflict]]{{·}}[[Scouting in popular culture]]{{·}}[[List of Scouts]]{{·}}[[List of highest awards in Scouting]]

|list2  = {{Navbox|child
|title      = [[French colonial empires|Former French colonies]] in [[Africa]] and the [[Indian Ocean]]
|titlestyle = background#
|groupstyle = background:lavender;

|group1 = [[Mahgreb]]
|list1  = [[French rule in Algeria|Algeria]]{{·}} [[French Morocco|Morocco]]&nbsp;<small>([[Arguin|Arguin Island]])</small>{{·}} [[History of Tunisia|Tunisia]]

|group2 = [[French West Africa]]
|list2  = [[History of Côte d'Ivoire#French Period|Côte d'Ivoire]]{{·}} [[French Dahomey|Dahomey]]{{·}} [[French Sudan]]{{·}} [[French Guinea|Guinea]]{{·}} [[History of Mauritania#French colonization and post-colonial history|Mauritania]]{{·}} [[History of Niger#Colonization|Niger]]{{·}} [[History of Senegal|Senegal]]{{·}} [[French Upper Volta|Upper Volta]]

|group3 = Togo
|list3  = [[French Togoland]]{{·}} [[James Island (The Gambia)|James Island]]

|group4 = [[French Equatorial Africa]]
|list4  = [[Colonial Chad|Chad]]{{·}} [[History of Gabon|Gabon]]{{·}} [[History of the Republic of the Congo|Middle Congo]]{{·}} [[Oubangui-Chari]]

|group5 = [[Comoros]]
|list5  = [[Anjouan]]{{·}} [[Grande Comore]]{{·}} [[Mohéli]]

|group6 = Southern Africa
|list6  = [[History of Djibouti#French interest|French Somaliland (Djibouti)]]{{·}} [[History of Madagascar#French control|Madagascar]]{{·}} [[Mauritius|Ile de France]]{{·}} [[Seychelles]]
}}

|group3 = [[Scouting in the United Kingdom]]
|abbr3  = Scouting
|list3  = [[The Scout Association]]{{·}}[[Girlguiding UK]]{{·}}[[Beaver Scouts]]{{·}}[[Cub Section (UK)]]{{·}}[[Venture Scout]]{{·}}[[Explorer Scouts]]{{·}}[[Brownie (Girl Guides)]]{{·}}[[Ranger (Girl Guide)]]{{·}}[[Rainbow (Girl Guides)]]{{·}}[[Scout Network]]{{·}}[[Chief Scout (United Kingdom)]]{{·}}[[Scout Counties]]{{·}}[[Scout District]]{{·}}[[Scout Section (UK)]]{{·}}[[Scout Activity Centre]]{{·}}[[Young Leaders (The Scout Association)|Young Leaders]]

|list4  = {{Navbox with columns|child
|title = Navbox with columns nested in itself
|colstyle = text-align:center;

|col1width = 33%
|col2width = 17%
|col3width = 33%
|col4width = 17%

|col1header = Col1Header
|col2header = Col2Header
|col3header = Col3Header
|col4header = Col4Header

|col1 = {{Navbox with columns|child
  |colwidth = 50%
  |colstyle = text-align:center;

  |col1header = Col1.1Header
  |col2header = Col1.2Header

  |col1 = Col1.1
  |col2 = Col1.2
 }}

|col2 = Col2

|col3 = {{Navbox with columns|child
  |colwidth = 33%
  |colstyle = text-align:center;

  |col1header = Col3.1Header
  |col2header = Col3.2Header
  |col3header = Col3.3Header

  |col1 = Col3.1
  |col2 = Col3.2
  |col3 = Col3.3
 }}

|col4 = Col4
}}
}}

== Footnotes ==
{{reflist}}

== Tracking category ==
* {{clc|Pages using navbox columns without the first column}}

== See also ==
{{Navigation templates}}

<includeonly>{{Sandbox other||
[[Category:Navigational boxes|columns]]
[[Category:Templates that add a tracking category]]
[[Category:Collapse templates]]
}}</includeonly>