Please remove the parameters that are left blank.
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):
Cells
- title*
- Text that appears centered in the top row of the table. It is usually the template's topic, i.e. a succinct description of the body contents. This should be a single line, but if a second line is needed, use
{{-}}
to ensure proper centering. This parameter is technically not mandatory, but using {{Navbox}} is rather pointless without a title.
- above*
- A full-width cell displayed between the titlebar and first group/list, i.e. above the template's body (groups, lists and image). In a template without an image, above behaves in the same way as the list1 parameter without the group1 parameter.
- groupn*
- (i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of listn. If omitted, listn uses the full width of the table.
- listn*
- (i.e. list1, list2, etc.) The body of the template, usually a list of links. Format is inline, although the text can be entered on separate lines if the entire list is enclosed within
<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).
- image*
- An image to be displayed in a cell below the title and to the right of the body (the groups/lists). For the image to display properly, the list1 parameter must be specified. The image parameter accepts standard wikicode for displaying an image, e.g.:
[[File:XX.jpg|80px|link=|alt=]]
- nb: including "|right" will produced the usual left margin to provide separation from the list items and zebra striping.
- imageleft*
- An image to be displayed in a cell below the title and to the left of the body (lists). For the image to display properly, the list1 parameter must be specified and no groups can be specified. It accepts the same sort of parameter that image accepts.
- below*
- A full-width cell displayed below the template's body (groups, lists and image). In a template without an image, below behaves in the same way as the template's final listn parameter without a groupn parameter.
Style parameters
Styles are generally advised against, to maintain consistency among templates and pages in Wikipedia; but the option to modify styles is given.
- style*
- Specifies CSS styles to apply to the template body. The parameter bodystyle also does the exact same thing and can be used in place of this style parameter. This option should be used sparingly as it can lead to visual inconsistencies. Examples:
style = background: #nnnnnn;
style = width: N [em/%/px or width: auto];
style = float: [left/right/none];
style = clear: [right/left/both/none];
- basestyle*
- CSS styles to apply to the title, above, below, and group cells all at once. The styles are not applied to list cells. This is convenient for easily changing the basic color of the navbox without having to repeat the style specifications for the different parts of the navbox. Examples:
basestyle = background: lightskyblue;
- titlestyle*
- CSS styles to apply to title, most often the titlebar's background color:
titlestyle = background: #nnnnnn;
titlestyle = background: name;
- groupstyle*
- CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:
groupstyle = background: #nnnnnn;
groupstyle = text-align: [left/center/right];
groupstyle = vertical-align: [top/middle/bottom];
- groupnstyle*
- CSS styles to apply to a specific group, in addition to any styles specified by the groupstyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
group3style = background: red; color: white;
- groupwidth
- A number and unit specifying a uniform width for the group cells, in cases where little content in the list cells may cause group cells to be too wide. No default. However, may be overridden by the group(n)style parameter. Examples:
groupwidth = 9em
- liststyle*
- CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) hereafter. When using backgound colors in the navbox, see the note hereafter.
- listnstyle*
- CSS styles to apply to a specific list, in addition to any styles specified by the liststyle parameter. This parameter should only be used when absolutely necessary in order to maintain standardization and simplicity. Examples:
list5style = background: #ddddff;
- listpadding*
- A number and unit specifying the padding in each list cell. The list cells come equipped with a default padding of 0.25em on the left and right, and 0 on the top and bottom. Due to complex technical reasons, simply setting "liststyle = padding: 0.5em;" (or any other padding setting) will not work. Examples:
listpadding = 0.5em 0;
(sets 0.5em padding for the left/right, and 0 padding for the top/bottom.)
listpadding = 0;
(removes all list padding.)
- 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
[swap, even, odd, off]
- If set to
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. This advanced parameter should only be used to fix problems when the navbox is being used as a child of another navbox and the stripes do not match up. Examples and a further description can be found in the section on child navboxes below.
- abovestyle*
- belowstyle*
- CSS styles to apply to the top cell (specified via the above parameter) and bottom cell (specified via the below parameter). Typically used to set background color or text alignment:
abovestyle = background: #nnnnnn;
abovestyle = text-align: [left/center/right];
belowstyle = background: #nnnnnn;
belowstyle = text-align: [left/center/right];
- imagestyle*
- imageleftstyle*
- CSS styles to apply to the cells where the image/imageleft sits. These styles should only be used in exceptional circumstances, usually to fix width problems if the width of groups is set and the width of the image cell grows too large. Examples:
imagestyle = width:5em;
Default styles
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;
.
Advanced parameters
- bodyclass
- aboveclass
- groupclass
- listclass
- belowclass
- This enables attaching a CSS class to group or list cells. The most common use for listclass is to give it the
hlist
class that will cause lists to render horizontally. All these parameters accept the hlist
class.
- titlegroup
- This puts a group in the title area, with the same default styles as groupn. It should be used only in exceptional circumstances (usually advanced meta-templates) and its use requires some knowledge of the internal code of {{Navbox}}; you should be ready to manually set up CSS styles to get everything to work properly if you wish to use it. If you think you have an application for this parameter, it might be best to change your mind, or consult the talk page first.
- titlegroupstyle
- The styles for the titlegroup cell.
- innerstyle
- A very advanced parameter to be used only for advanced meta-templates employing the navbox. Internally, the navbox uses an outer table to draw the border, and then an inner table for everything else (title/above/groups/lists/below/images, etc.). The style/bodystyle parameter sets the style for the outer table, which the inner table inherits, but in advanced cases (meta-templates) it may be necessary to directly set the style for the inner table. This parameter provides access to that inner table so styles can be applied. Use at your own risk.
Microformats
- bodyclass
- This parameter is inserted into the "class" attribute for the navbox as a whole.
- titleclass
- This parameter is inserted into the "class" attribute for the navbox'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:
| bodyclass = vcard
and
| titleclass = fn
or (for example):
| title = The books of <span class="fn">[[Iain Banks]]</span>
...and so forth.
Layout of table
Table generated by {{Navbox}} without image, above and below parameters (gray list background color added for illustration only):
{{{title}}} |
---|
| {{{group1}}} |
{{{list1}}} |
---|
| {{{group2}}} |
{{{list2}}} |
---|
|
{{{list3}}} without {{{group3}}} | | {{{group4}}} |
{{{list4}}} |
---|
|
Table generated by {{Navbox}} with image, above and below parameters (gray list background color added for illustration only):
{{{title}}} |
---|
|
{{{above}}} | | {{{group1}}} |
{{{list1}}} |
{{{image}}} |
---|
| {{{group2}}} |
{{{list2}}} |
---|
|
{{{list3}}} without {{{group3}}} | | {{{group4}}} |
{{{list4}}} |
---|
|
{{{below}}} |
|
Table generated by {{Navbox}} with image, imageleft, lists, and without groups, above, below (gray list background color added for illustration only):
{{{title}}} |
---|
|
{{{imageleft}}} |
{{{list1}}} |
{{{image}}} | |
{{{list2}}} | |
{{{list3}}} | |
{{{list4}}} |
|
Examples
No image
{{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 =
* EGovernment
* MyKad
}}
MSC Malaysia |
---|
| Centre | |
---|
| Area |
Klang Valley |
---|
| Major landmarks |
Petronas Twin Towers
Kuala Lumpur Tower
Kuala Lumpur Sentral
Technology Park Malaysia
Putrajaya
Cyberjaya
Kuala Lumpur International Airport |
---|
| Infrastructure |
Express Rail Link
KL-KLIA Dedicated Expressway |
---|
| Prime applications |
EGovernment
MyKad |
---|
|
With image, without groups
{{Navbox
| name = Navbox/doc
| title = MSC Malaysia
| listclass = hlist
| image = [[File:G8ME01.png|80px|link=|alt=]]
| list1 =
* Petronas Twin Towers
* Kuala Lumpur Tower
* Kuala Lumpur Sentral
* Technology Park Malaysia
* Putrajaya
* Cyberjaya
* Kuala Lumpur International Airport
}}
MSC Malaysia |
---|
|
- Petronas Twin Towers
- Kuala Lumpur Tower
- Kuala Lumpur Sentral
- Technology Park Malaysia
- Putrajaya
- Cyberjaya
- Kuala Lumpur International Airport
| |
|
With two images, without groups, multiple lists
{{Navbox
| name = Navbox/doc
| title = MSC Malaysia
| listclass = hlist
| image = [[File:G8ME01.png|80px|link=|alt=]]
| imageleft = [[File:G8ME01.png|80px]]
| list1 =
* Petronas Twin Towers
* Kuala Lumpur Tower
* Kuala Lumpur Sentral
| list2 =
* Express Rail Link
* KL-KLIA Dedicated Expressway
| list3 =
* EGovernment
* MyKad
| list4 =
* Klang Valley
}}
MSC Malaysia |
---|
| |
- Petronas Twin Towers
- Kuala Lumpur Tower
- Kuala Lumpur Sentral
| | |
- Express Rail Link
- KL-KLIA Dedicated Expressway
| |
EGovernment
MyKad | |
Klang Valley |
|
With image, groups, above, below
{{Navbox
| name = Navbox/doc
| title = MSC Malaysia
| listclass = hlist
| above = Above text goes here
| image = [[File:G8ME01.png|80px|link=|alt=]]
| 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
| group4 = Infrastructure
| list4 =
* Express Rail Link
* KL-KLIA Dedicated Expressway
| group5 = Prime applications
| list5 =
* EGovernment
* MyKad
| below = Website: [http://www.msc.com.my/]
}}
MSC Malaysia |
---|
|
Above text goes here | | Centre | | |
---|
| Area | |
---|
| Major landmarks |
Petronas Twin Towers
Kuala Lumpur Tower
Kuala Lumpur Sentral
Technology Park Malaysia
Putrajaya
Cyberjaya |
---|
| Infrastructure |
Express Rail Link
KL-KLIA Dedicated Expressway |
---|
| Prime applications |
EGovernment
MyKad |
---|
| |
|
Child navboxes
It is possible to place multiple navboxes within a single border with the use of the border parameter, or by specifying the first parameter to be "child". 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...
}}
...
}}
Subgroups example
This example shows how subgroups can be used. It is recommended that one use {{Navbox subgroup}}, but the same result can be reached by using {{Navbox}} with border = child
or the first unnamed parameter set to child
. The evenodd parameter is used to reverse striping in some of the subgroups in order to get all of the stripes to line up properly. To remove the striping altogether, you can set liststyle = background:transparent;
in each of the navboxes.
Multiple subgroup example |
---|
|
Above | | Group1 |
List1 | |
---|
| Group2 |
Group2.1 |
List1 |
---|
| Group2.2 |
List2 |
---|
| Group2.3 |
List3 |
---|
|
---|
| Group3 |
List3 |
---|
| Group4 |
Group4.1 |
List1 |
---|
| Group4.2 |
List2 |
---|
| Group4.3 |
List3 |
---|
|
---|
|
Below |
|
Multiple show/hides in a single container
The example below is generated using a regular navbox for the main container, then its list1, list2, and list3 parameters each contain another navbox, with 1 = child
set. The view (v), discuss (d), edit (e) navbar links are hidden using navbar = plain
for each of them, or could be suppresed by just leaving out the name parameter (child navboxes do not require the name parameter to be set, unlike regular navboxes).
Former French overseas empire |
---|
|
Former French colonies in Africa and the Indian Ocean |
---|
| Mahgreb |
- Algeria
- Morocco (Arguin Island)
- Tunisia
|
---|
| French West Africa |
Côte d'Ivoire
Dahomey
Sudan
Guinea
Mauritania
Niger
Senegal
Upper Volta
French Togoland
James Island |
---|
| French Equatorial Africa |
Chad
Gabon
Middle Congo
Oubangui-Chari |
---|
| Comoros |
Anjouan
Grande Comore
Mohéli
French Somaliland (Djibouti)
Madagascar
Ile de France
Seychelles |
---|
| |
Former French colonies in the Americas |
---|
|
- New France (Acadia, Louisiana, Canada, Terre Neuve) 1655–1763
| |
Inini
Berbice
Saint-Domingue
Haiti
Tobago
Virgin Islands
France Antarctique
France Équinoxiale | |
French West India Company |
| |
Former French colonies in Asia and Oceania |
---|
| French India |
- Chandernagor
- Coromandel Coast
- Madras
- Mahé, India
|
---|
| French Indochina |
Cambodia
Laos
Vietnam (Annam, Cochinchina, Tonkin) |
---|
| Other Asian |
Alaouites
Alexandretta-Hatay
Ceylon
Kwangchowan |
---|
| Oceania | |
---|
|
French East India Company |
|
|