Wikipedia>Ahecht: {{Lua|Module:Navbox}}

2025-01-24T15:22:15Z

New page

{{Documentation subpage}}
{{High-use}}
{{Template display|nomobile}}
{{Lua|Module:Navbox}}
{{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.

<syntaxhighlight lang="wikitext" style="overflow:auto;">
{{Navbox with columns
| name = {{subst:PAGENAME}}
| title =
| colwidth = 
| col1 =
| col2 =
}}
</syntaxhighlight>
<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 '''[1]''' 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.
;''colnstyle''
:CSS style/s to apply to the nth column only.
;''colheaderstyle''
:CSS style/s to apply to all column headers.
;''colnheaderstyle''
:CSS style/s to apply to the nth column header.
;''colnfooterstyle''
:CSS style/s to apply to the nth 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%).
;''colnwidth''
:The nth column's width (overrides ''colwidth'' above).
;'''''coln'''''
:The content of the nth column. If any columns are used, then <code>col1</code> is required. There can be a maximum of 20 columns.
;''colnheader''
:A header cell for the nth column that appears above the column. See below for examples.
;''colnfooter''
:A footer cell that appears below the nth column.
;''colnheadercolspan''
:A number specifying how many columns the nth 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.
;''colnfootercolspan''
:A number specifying how many columns the nth 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.

;''groupn''<ref name="common"/>
:Allows up to 6 additional groups to go along with the lists below the columns.
;''listn''<ref name="common"/>
:Allows up to 6 additional lists below the columns.
;''groupstyle''<ref name="common"/>
:The general CSS style/s for the groups.
;''groupn''style†
:CSS style/s for the nth group parameter.<ref name="common"/>
;''liststyle''<ref name="common"/>
:The general CSS style/s for the lists.
;''listnstyle''
:CSS style/s for the nth 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'' <code>[swap, even, odd, off]</code>
: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):

<syntaxhighlight lang="wikitext">
|title = The books of [[Iain Banks]]
</syntaxhighlight>

...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="wikitext" 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 =
* [[Australia]]
* [[Brunei]]
* [[Burma]]

| col2 =
* [[Cambodia]]
* [[China]]
* [[India]]

| col3 =
* [[Indonesia]]
* [[Japan]]
* [[Laos]]

| col4 =
* [[Malaysia]]
* [[New Zealand]]
* [[Philippines]]

| col5 =
* [[Russia]]
* [[Singapore]]
* [[South Korea]]

| col6width = 17em
| col6 =
* [[Thailand]]
* [[United States]]
* [[Vietnam]]
}}
</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 =
* [[Australia]]
* [[Brunei]]
* [[Burma]]

| col2 =
* [[Cambodia]]
* [[China]]
* [[India]]

| col3 =
* [[Indonesia]]
* [[Japan]]
* [[Laos]]

| col4 =
* [[Malaysia]]
* [[New Zealand]]
* [[Philippines]]

| col5 =
* [[Russia]]
* [[Singapore]]
* [[South Korea]]

| col6width = 17em
| col6 =
* [[Thailand]]
* [[United States]]
* [[Vietnam]]
}}

===Example with percentage widths===
<syntaxhighlight lang="wikitext" 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 colnheader and colnfooter===
The gray background for the columns is added for illustration only.
{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = colnheader and colnfooter 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 colnheader using colnheadercolspan===
The gray background for the columns is added for illustration only. This example shows the colnheadercolspan parameter being used, but you may also use colnfootercolspan to adjust the span of the footer cells.
{{Navbox with columns
|name = Navbox with columns/doc
|state = uncollapsed
|title = colnheader with colncolspan 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 types of navbox templates can be nested inside of one another. For complex templates, it may be necessary to use nesting to achieve a desired look. {{tl|Navbox}}, {{tl|Navbox with columns}}, and {{tl|Navbox with collapsible groups}} can be nested using the inline notation documented at [[Template:Navbox/doc#Child navboxes]]. Other types of navbox templates can be nested inside of one another using the <code>border</code> parameter (which is common to all three).

===Nesting navboxes===
To nest a navbox, set the <code>coln</code> parameter to <code>child</code> or <code>subgroup</code>. Elements of the child navbox can be specified by prepending <code>coln_</code> to the parameter names (e.g. <code>col1_list1</code>). Child navboxes can be nested by adding an additional prefix (e.g. <code>col1_1_list1</code>).

To nest a navbox inside a list, set the <code>listn</code> parameter to <code>child</code> or <code>subgroup</code>. Elements of the child navbox can be specified by prepending <code>childn_</code>, <code>subgroupn_</code>, or just <code>n_</code> to the parameter names (e.g. <code>1_list1</code>). Child navboxes can be nested by adding an additional prefix (e.g. <code>1_1_list1</code>).

The basic code for doing this is as follows (which adds a subgroup for the first column and for the first group/list area):

<syntaxhighlight lang="wikitext" style="overflow: auto;">
{{Navbox with columns
| name = {{subst:PAGENAME}}
| title = Title

| col1 = child
| col1_title = [optional]

| col1_group1 = [optional]
| col1_list1 =
...list contents...
...

| group1 = Group Title
| list1 = child
| 1_title = [optional]

| 1_group1 = [optional]
| 1_list1 = child
| 1_1_title = [optional]

| 1_1_group1 = [optional]
| 1_1_list1 =
...list contents...
...
...
}}
</syntaxhighlight>

{{Navbox with columns
| name = {{ROOTPAGENAME}}/doc
| title = {{ROOTPAGENAME}} with nested Navboxes

| col1header = Column 1 Header
| col1 = Column 1
| col2header = Column 2 Header
| col2 = child
| col2_group1 = Column 2 Child Navbox Group 1
| col2_list1 = Column 2 Child Navbox List 1
| col2_list2 = Column 2 Child Navbox List 2

| group1 = Group 1 Title
| list1 = child
| 1_group1 = Group 1 Child Navbox Group 1
| 1_list1 = child
| 1_1_group1 = Group 1 Child Navbox's Child Navbox Group 1
| 1_1_list1 = Group 1 Child Navbox's Child Navbox List 1
| 1_1_list2 = Group 1 Child Navbox's Child Navbox List 2
|1_group2 = Group 1 Child Navbox Group 2
|1_list2 = Group 1 Child Navbox List 2
}}

=== Relationship with other Navbox templates ===
This navbox template works in conjunction with two other templates: {{tl|Navbox}} and {{tl|Navbox with collapsible groups}}. All three of these templates share common parameters for consistency and ease of use (such parameters are marked with an asterisk (*) in the [[Template:Navbox/doc#Parameter descriptions|parameter descriptions]] list at [[Template:Navbox/doc]]). Most importantly, each template can be used as a child of one another. Using the inline notation, the <code>n_type=</code> parameter can be set to <code>with columns</code> or <code>with collapsible groups</code> to set the type of that child navbox, as shown in the example below. Press the edit button for the section to view the code.

=== 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 Navbox with columns templates, with the <code>coln_type=with columns</code> 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 = child
|col1_type = with columns
|col1_colwidth = 50%
|col1_colstyle = text-align:center;background:silver;

|col1_col1header = Col1.1Header
|col1_col2header = Col1.2Header

|col1_col1 = Col1.1
|col1_col2 = Col1.2

|col2 = Col2

|col3 = child
|col3_type=with columns
|col3_colwidth = 33%
|col3_colstyle = text-align:center;background:silver;

|col3_col1header = Col3.1Header
|col3_col2header = Col3.2Header
|col3_col3header = Col3.3Header

|col3_col1 = Col3.1
|col3_col2 = Col3.2
|col3_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 columns
|name = Template:Navbox/doc
|title = Navbox with nested regular Navbox, Navbox with Collapsible Groups, and Navbox with Columns
|listclass = hlist
|col1header = Regular Navbox
|col1 = subgroup
|col1_group1 = Group 1
|col1_list1 =
* List 1.1
* List 1.2
|col1_group2 = Group 2
|col1_list2 =
* List 2.1
* List 2.2
|col2header = Navbox with Collapsible Groups
|col2 = subgroup
|col2_type = with collapsible groups
|col2_group1 = Group 1
|col2_list1 =
* List 1.1
* List 1.2
|col2_group2 = Group 2
|col2_list2 =
* List 2.1
* List 2.2
|col3header = Navbox with Columns
|col3 = subgroup
|col3_type = with columns
|col3_col1header = Column 1
|col3_col1 =
* List 1.1
* List 1.2
|col3_col2header = Column 2
|col3_col2 =
* List 2.1
* List 2.2

|list11 = subgroup
|11_title = Regular Navbox
|11_group1 = Group 1
|11_list1 =
* List 1.1
* List 1.2
|11_group2 = Group 2
|11_list2 =
* List 2.1
* List 2.2
|list12 = subgroup
|12_title = Navbox with Collapsible Groups
|12_type = with collapsible groups
|12_group1 = Group 1
|12_list1 =
* List 1.1
* List 1.2
|12_group2 = Group 2
|12_list2 =
* List 2.1
* List 2.2
|list13 = subgroup
|13_title = Navbox with Columns
|13_type = with columns
|13_col1header = Column 1
|13_col1 =
* List 1.1
* List 1.2
|13_col2header = Column 2
|13_col2 =
* List 2.1
* List 2.2
}}

You can also nest these or other navbox templates by using the {{para|border|child}} parameter, or by specifying the first unnamed parameter to be <code>child</code>. For example: <code><nowiki>{{Navbox|child ...}}</nowiki></code>, <code><nowiki>{{Navbox with columns|child ...}}</nowiki></code> or <code><nowiki>{{Navbox with collapsible groups|child ...}}</nowiki></code>. Note that this style of nesting can lead to a large increase in the template's [[WP:PEIS|post-expand include size]].

== Technical details ==
* This template calls [[Module:Navbox]] to render the navbox.
* Navbox templates, including this one, are a major contributor to the [[WP:PEIS|post-expand include size]] of pages, and can cause pages to exceed the limit and not render correctly. There are a few ways to mitigate this.
** {{tlx|{{ROOTPAGENAME}}}} can be replaced with {{mlx|Navbox|with columns}}, which approximately halves the include size
** Nesting other templates inside of a navbox can cause the include size increase by a factor of two or more. This template supports the same in-line child syntax documented at [[Template:Navbox/doc#Child navboxes]], which mitigates this, but only for plain Navboxes, Navboxes with columns, and Navboxes with collapsible groups (not other types of navboxes).

==Aliases==
{{Talias}}

== Footnotes ==
{{reflist}}

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

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

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

Template:Navbox with columns/doc - Revision history

CapybaraKiller: 1 revision imported from :Wikipedia:Template:Navbox_with_columns/doc

Wikipedia>Ahecht: {{Lua|Module:Navbox}}

← Older revision	Revision as of 00:09, 26 May 2025
(No difference)