![]() | This template is used on approximately 2,950,000 pages, or roughly 5% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Preview message: Transclusion count updated automatically (see documentation). |
![]() | This template does not display in the mobile view of Wikipedia; it is desktop only. Read the documentation for an explanation. |
![]() | This template uses Lua: |
Navbox suite |
---|
|
Related pages |
---|
This template allows a navigational template to be set up relatively quickly by supplying it with one or more lists of links. It comes equipped with default styles that should work for most navigational templates. Changing the default styles is possible, but not recommended. Using this template, or one of its "Navbox suite" sister templates, is highly recommended for standardization of navigational templates, and for ease of use.
Templates using the classes class=navbox
({{navbox}}) or class=nomobile
({{sidebar}}) are not displayed on the mobile web site of English Wikipedia. Mobile page views account for approximately 66% of all page views (90-day average as of January 2024[update]).
Please remove the parameters that are left blank.
{{Navbox
| name = {{subst:PAGENAME}}{{subst:void|Don't change anything on this line. It will change itself when you save.}}
| title =
| listclass = hlist
| state = {{{state|}}}
| above =
| image =
| group1 =
| list1 =
| group2 =
| list2 =
| group3 =
| list3 =
<!-- ... -->
| below =
}}
The navbox uses lowercase parameter names, as shown in the box (above). The required name and title will create a one-line box if other parameters are omitted.
Notice "group1" (etc.) is optional, as are sections named "above/below".
The basic and most common parameters are as follows (see below for the full list):
name
– the name (Wikipedia location) of the template.title
– text in the title bar, such as: [[Widget stuff]].listclass
– a CSS class for the list cells, usually hlist
for horizontal lists. Alternatively, use bodyclass for the whole box.state
– controls when a navbox is expanded or collapsed.titlestyle
– a CSS style for the title-bar, such as: background: gray;
groupstyle
– a CSS style for the group-cells, such as: background: #eee;
above
– text to appear above the group/list section (could be a list of overall wikilinks).image
– an optional right-side image, coded as the whole image, such as: [[File:XX.jpg|80px|alt=Alternate text]]
imageleft
– an optional left-side image (code the same as the "image" parameter).groupn
– the left-side text before list-n (if group-n omitted, list-n extends to the left edge of the box, and defaults to text-align:center
styling).listn
– text listing wikilinks using a wikilist format.below
– optional text to appear below the group/list section.The following is a complete list of parameters for using {{Navbox}}. In most cases, the only required parameters are name
, title
, and list1
, though child navboxes do not even require those to be set.
{{Navbox}} shares numerous common parameter names with its sister templates, {{Navbox with columns}} and {{Navbox with collapsible groups}}, for consistency and ease of use. Parameters marked with an asterisk (*) are common to all three master templates.
{{subst:PAGENAME}}
for this value as a shortcut. The name parameter is only mandatory if a title
is specified, and the border
parameter is not set, and the navbar
parameter is not used to disable the navbar.autocollapse, collapsed, expanded, plain, off
]autocollapse
. A navbox with autocollapse
will start out collapsed if there are two or more collapsible elements on the same page. Otherwise, the navbox will be expanded. For the technically minded, see MediaWiki:Common.js (search for "autocollapse").collapsed
, the navbox will always start out in a collapsed state.expanded
, the navbox will always start out in an expanded state.plain
, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the V • T • E links).off
, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered. This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.<noinclude>...</noinclude>
tags. This setting will force the box to be visible when standalone (even when followed by other boxes), displaying "[hide]", but then it will auto-collapse the box when stacked inside an article:
| state =
<noinclude>expanded</noinclude>
| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}
<includeonly>
|
will make the template expanded when viewing the template page by itself.
| state = {{{state<includeonly>|expanded</includeonly>}}}All transcluding articles show the content by default, unless there is a hypothetical article that specifies
{{templatename|state=collapsed}}
when transcluding.| state = {{{state<includeonly>|collapsed</includeonly>}}}All transcluding articles will show the template as collapsed by default, but the template will still be uncollapsed when displayed on its own page.
state
parameter. It can be added to a <noinclude>...</noinclude>
section after the template definition or to the instructions on the {{documentation subpage}}.plain
, the V • T • E links on the left side of the titlebar will not be displayed, and padding will be automatically used to keep the title centered. Use off
to remove the V • T • E links, but not apply padding (this is for advanced use only; the "plain" option should suffice for most applications where a navbar is not desired). It is highly recommended that one not hide the navbar, in order to make it easier for users to edit the template, and to keep a standard style across pages.child
or subgroup
, then the navbox can be used as a borderless child that fits snugly in another navbox. The border is hidden and there is no padding on the sides of the table, so it fits into the list area of its parent navbox. If set to none
, then the border is hidden and padding is removed, and the navbox may be used as a child of another container (do not use the none
option inside of another navbox; similarly, only use the child
/subgroup
option inside of another navbox). If set to anything else (default), then a regular navbox is displayed with a 1px border. An alternate way to specify the border to be a subgroup style is like this (i.e. use the first unnamed parameter instead of the named border parameter):{{Navbox|child|...}}
{{-}}
to ensure proper centering. This parameter is technically not mandatory, but using {{Navbox}} is rather pointless without a title.<div> </div>
. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter, if provided (see below).child
or subgroup
to denote that the list is using the inline #Child navboxes (does not work with {{Navbox with columns}} or {{Navbox with collapsible groups}}).[[File:</nowiki><var>XX</var><nowiki>.jpg|80px|link=|alt=]]nb: including "|right" will produce the usual left margin to provide separation from the list items and zebra striping.
{{icon|category}} [[:Category:name|Category]]
.Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.
bodystyle = background: #nnnnnn;
bodystyle = width: N [em/%/px or width: auto];
bodystyle = float: [left/right/none];
bodystyle = clear: [right/left/both/none];
basestyle = background: lightskyblue;
titlestyle = background: #nnnnnn;
titlestyle = background: name;
titlestyle = background: none;
— for no background colorgroupstyle = background: #nnnnnn;
groupstyle = text-align: [left/center/right];
groupstyle = vertical-align: [top/middle/bottom];
group3style = background: red; color: white;
groupwidth = 9em
list5style = background: #ddddff;
listpadding = 0.5em 0;
(sets 0.5em padding for the top/bottom, and 0 padding for the left/right.)listpadding = 0;
(removes all list padding.)[swap, even, odd, off]
swap
, then the automatic striping of even and odd rows is reversed. Normally, even rows get a light gray background for striping; when this parameter is used, the odd rows receive the gray striping instead of the even rows. Setting to even
or odd
sets all rows to have that striping color. Setting to off
disables automatic row striping.abovestyle = background: #nnnnnn;
abovestyle = text-align: [left/center/right];
belowstyle = background: #nnnnnn;
belowstyle = text-align: [left/center/right];
imagestyle = width:5em;
The style settings listed here are those that editors using the navbox change most often. The other more complex style settings were left out of this list to keep it simple. Most styles are set in MediaWiki:Common.css.
bodystyle = background: #fdfdfd; width: 100%; vertical-align: middle;
titlestyle = background: #ccccff; padding-left: 1em; padding-right: 1em; text-align: center;
abovestyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;
belowstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: center;
groupstyle = background: #ddddff; padding-left: 1em; padding-right: 1em; text-align: right;
liststyle = background: transparent; text-align: left/center;
oddstyle = background: transparent;
evenstyle = background: #f7f7f7;
Since liststyle and oddstyle are transparent, odd lists have the color of the bodystyle, which defaults to #fdfdfd (white with a hint of gray). A list defaults to text-align: left;
if it has a group, if not it defaults to text-align: center;
. Since only bodystyle has a vertical-align all the others inherit its vertical-align: middle;
.
hlist
class that will cause lists to render horizontally. All these parameters accept the hlist
class, but if more than one parameter is used for hlist
, use |bodyclass=hlist
instead.nowraplinks
which can be overridden, for example with |listclass=wraplinks
.|nowrapitems=yes
applies nowrap to each line in a list item, and to any above
or below
item.|orphan=yes
in a child navbox fixes odd/even striping and removes Category:Navbox orphans.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.
See Wikipedia:WikiProject Microformats for more information on adding microformat information to Wikipedia, and microformat for more information on microformats in general.
Table generated by {{Navbox}} without image, above and below parameters (gray list background color added for illustration only):
Table generated by {{Navbox}} with image, above and below parameters (gray list background color added for illustration only):
Table generated by {{Navbox}} with image, imageleft, lists, and without groups, above, below (gray list background color added for illustration only):
{{Navbox
| name = Navbox/doc
| title = [[MSC Malaysia]]
| listclass = hlist
| group1 = Centre
| list1 =
* [[Cyberjaya]]
| group2 = Area
| list2 =
* [[Klang Valley]]
| group3 = Major landmarks
| list3 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]
| group4 = Infrastructure
| list4 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]
| group5 = Prime applications
| list5 =
* [[E-Government]]
* [[MyKad]]
}}
It is possible to place multiple navboxes within a single border. These can either be specified inline or by using a nested navbox template, although the latter method can result in a signifcantly large post-expand include size.
To specify child navboxes inline, set the listn
parameter to child
or subgroup
. Elements of the child navbox can be specified by prepending childn_
, subgroupn_
, or just n_
to the parameter names (e.g. 1_list1
). Child navboxes can be nested by adding an additional prefix (e.g. 1_1_list1
). The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
{{Navbox | name = {{subst:PAGENAME}} | title = Title | group1 = [optional] | list1 = child | 1_title = [optional] | 1_group1 = [optional] | 1_list1 = child | 1_1_title = [optional] | 1_1_group1 = [optional] | 1_1_list1 = ...list contents... ... ... }}
To specify child navboxes using a nested template, use "child" as the first parameter or set the border parameter. The basic code for doing this is as follows (which adds a subgroup for the first group/list area):
{{Navbox | name = {{subst:PAGENAME}} | title = Title | group1 = [optional] | list1 = {{Navbox|child ...child navbox parameters... }} ... }}
This example shows two subgroups and a sub-subgroup created using child
and subgroup
keywords (both are interchangible). The striping is alternated automatically. To remove the striping altogether, you can set childn_liststyle = background:transparent;
in each.
The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another nested navbox template, with 1 = child
set. The view (v), talk (t), edit (e) navbar links are hidden using navbar = plain
for each of them, or could be suppressed by just leaving out the name parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes). The navbar links are hidden by default when using the inline notation.
This navbox template works in conjunction with two other templates: {{Navbox with columns}} and {{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 parameter descriptions list hereinbefore). Most importantly, each template can be used as a child of one another (by using the |border=child
parameter, or by specifying the first unnamed parameter to be child
. For example: {{Navbox|child ...}}
, {{Navbox with columns|child ...}}
or {{Navbox with collapsible groups|child ...}}
.)
bodystyle = background:purple;
), then you'll need to make the border-left-color match the background color (i.e. liststyle = border-left-color: purple;
). If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.style/bodystyle
, then this will not work.bodystyle = width: 22em; float: right; margin-left: 1em; margin-right: 0;
{{#invoke:Navbox|navbox
| name = {{subst:PAGENAME}}
| title = Title
| group1 = [optional]
| list1 = {{#invoke:Navbox|navbox|child
...child navbox parameters...
}}
...
}}
If you are trying to copy {{Navbox}} to your local wiki, there are several other things that must be installed or copied over as well:
Add support to mw-collapsible for autocollapse, innercollapse and outercollapse
script from MediaWiki:Common.js may be copied, if autocollapsing is desired.TemplateData for Navbox
Creates a navigational box for links to other pages. Does not display in mobile.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Name | name | The name of the template. Needed for "View • Talk • Edit" links to work properly.
| String | suggested |
Title | title | Text in the title bar; centered in the top row of the table. Usually the template's topic.
| Unknown | suggested |
Group 1 | group1 | If specified, text appears in a header cell displayed to the left of list 1. If omitted, list 1 uses the full width of the table. | Unknown | suggested |
List 1 | list1 | Body of the template; usually a list of links. Format is inline. At least one list parameter is required; each additional list is displayed in a separate row of the table. Each listn may be preceded by a corresponding groupn parameter. Entries should be separated using a newline and an asterisk. If two asterisks are used, it provides nesting within the previous entry with brackets. | Unknown | required |
List class | listclass | CSS class for the list cells, usually hlist for horizontal lists. Alternatively, use bodyclass for the whole box.
| String | optional |
State | state | Controls when a navbox is expanded or collapsed
| Unknown | suggested |
Above | above | Full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image) | String | suggested |
Below | below | Full-width cell displayed below the template's body. | Unknown | suggested |
Image | image | Image to be displayed in a cell below the title and to the right of the body
| File | suggested |
group2 | group2 | no description | Unknown | suggested |
list2 | list2 | no description | Unknown | suggested |
group3 | group3 | no description | Unknown | suggested |
list3 | list3 | no description | Unknown | suggested |
group4 | group4 | no description | Unknown | optional |
list4 | list4 | no description | Unknown | optional |
Image left | imageleft | Image to be displayed in a cell below the title and to the left of the body. For the image to display properly, list1 parameter must be specified and no groups can be specified.
| File | optional |
Navbar status | navbar | no description
| String | optional |
Border status | border | no description
| String | optional |
bodystyle | bodystyle | no description | Unknown | optional |
basestyle | basestyle | no description | Unknown | optional |
titlestyle | titlestyle | no description | Unknown | optional |
groupstyle | groupstyle | no description | Unknown | optional |
liststyle | liststyle | no description | Unknown | optional |
group1style | group1style | no description | Unknown | optional |
list1style | list1style | no description | Unknown | optional |
groupwidth | groupwidth | no description | Unknown | optional |
listpadding | listpadding | no description | Unknown | optional |
oddstyle | oddstyle | no description | Unknown | optional |
evenstyle | evenstyle | no description | Unknown | optional |
evenodd | evenodd | no description
| Unknown | optional |
abovestyle | abovestyle | no description | Unknown | optional |
belowstyle | belowstyle | no description | Unknown | optional |
imagestyle | imagestyle | no description | Unknown | optional |
imageleftstyle | imageleftstyle | no description | Unknown | optional |
hlist
class for formatting lists. See Flatlist for a technical explanation of how hlist
works.Template | Collapsible | Header color | Image | Groups | Style (body) parameter/s |
---|---|---|---|---|---|
{{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes |
{{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes |
{{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes |
Type | CSS classes | JavaScript | Collapses when | Custom initial state |
Nesting |
---|---|---|---|---|---|
Collapsible tables | mw-collapsible | jQuery.makeCollapsible | 2 or more autocollapse on page | Yes | Yes |
© MMXXIII Rich X Search. We shall prevail. All rights reserved. Rich X Search