View source for Template:Navbox with columns/doc

{{Documentation subpage}}
{{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      = 
|titleclass = 
|bodyclass  = 
|colwidth =  <!--(to set a default width for each column,
                  preferably in a proportional unit such as 'em'*)-->
|col1  = 
|col2  = 
}}
</pre>
<div style="line-height:1.35em; font-size:90%;">* 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.</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.

===Basic data parameters===
:;'''''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"/>
::CSS style/s to apply to titlebar; usually <code>background:''color''</code> (background defaults to NavHead 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

:;''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', or as a percentage, used for each column whose width not specified by ''colNwidth'' below. Defaults to 10em.  Examples:
:::<code>colwidth = 15em</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 = true</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.


== Examples ==
===Basic example===
<pre style="overflow:scroll;">
{{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 <nowiki>{{{above}}}</nowiki> 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}}
}}
</pre>


===Example with percentage widths===
<pre style="overflow:scroll;">
{{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)
}}
</pre>


==Footnote==
<references/>

== See also ==
{{Navigational templates}}

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!--Categories-->
[[Category:Navigational boxes| ]]

<!--Other languages-->

}}</includeonly>