Template:Navbox generic/doc

This is a documentation subpage for Template:Navbox generic.
It contains usage information, categories and other content that is not part of the original template page.

This template employs intricate features of template syntax.

You are encouraged to familiarise yourself with its setup and parser functions before editing the template. If your edit causes unexpected problems, please undo it quickly, as this template may appear on a large number of pages.
Remember that you can conduct experiments, and should test all improvements, in either the general Template sandbox or your user space before changing anything here.

This template allows a navigational template to be set up relatively quickly by supplying it one or more lists of links.

Blank template

{{Navbox generic
| name  = {{subst:PAGENAME}}
| title = 
| state = 
| image = 

| titlestyle = 
| bodystyle  =   <!-- (or "style =" if no other style parameters used) -->
| groupstyle = 
| liststyle  = 
| oddstyle   = 
| evenstyle  = 
| abovestyle = 
| belowstyle = 

| above  = 

| group1 = 
| list1  = 

| group2 = 
| list2  = 

  ...

| group20 = 
| list20  = 

| below   = 
}}

Parameters

Deprecated (but still functional) parameter names given in parentheses before each description.

Mandatory

name: (or templateName) The name of the template, which is needed for the "v · d · e" ("view · discuss · edit") links to work properly on all pages where the template is used. You can enter {{subst:PAGENAME}} for this value as a shortcut.

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.; The background color defaults to #ccf (truncated form of #ccccff), but can be changed via the titlestyle parameter (see below).

list_n: (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> (see #Example with code). At least one list parameter is required; each additional list is displayed in a separate row of the table. Each list_n may be preceded by a corresponding group_n parameter, if provided (see below).; The background color of the list items (and the entire table) defaults to #f9f9f9, but can be changed via the bodystyle, oddstyle and/or evenstyle parameters (see below).

Optional

Cells

group_n: (i.e. group1, group2, etc.) If specified, text appears in a header cell displayed to the left of list_n. If omitted, list_n uses the full width of the table.; The background color defaults to #ddf (truncated form of #ddddff), but can be changed via the groupstyle parameter (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, i.e.

[[Image:Example.jpg|100px]]


In a template where the body (the groups and/or lists) does not extend all the way to the right side, the image will shift away from the right edge of the template. This can be avoided by using the right parameter within the image wikicode, i.e.
[[Image:Example.jpg|80px|right]]

above
(or top) 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.

below
(or bottom) 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 list_n parameter without a group_n parameter. For an example of the below parameter in use, see {{Lists of the provinces and territories of Canada}}.

Styles

titlebkg
(or color) This parameter allows setting a color value for the background of the titlebar. This can also be set using the newer titlestyle parameter documented below. Where it is used, care and consensus are needed as multiple navigational templates on one page with different background colors will probably look unpleasant.
titlebkg = #nnnnnn
titlebkg = name

titlestyle
(or title_style) CSS styles to apply to title, most often the titlebar's background color:
titlestyle = background:#nnnnnn;
titlestyle = background:name;

bodystyle or style
Specifies CSS styles to apply to the template body. The shorter name style may be used when no other style parameters are specified. This option should be used sparingly as it can lead to visual inconsistencies. Examples:
background:#nnnnnn;
text-align:[right/center/left/justified];
width:N [em/%/px or width:auto];
float:[left/right/none];
clear:[right/left/both/none];

groupstyle
(or group_style, group-style) CSS styles to apply to the groupN cells. This option overrides any styles that are applied to the entire table. Examples:
background:#nnnnnn;
text-align:[left/center/right];
vertical-align:[top/middle/bottom];
white-space:nowrap;

liststyle
CSS styles to apply to all lists. Overruled by the oddstyle and evenstyle parameters (if specified) below.

oddstyle
evenstyle
(or odd-style, even-style) CSS styles to apply to the odd-numbered list items (list1, list3, etc) or even-numbered list items (list2, list4, etc), respectively. Typically used to set background color (background:#nnnnnn;) in order to achieve an alternating background color between odd and even-numbered lists; see {{Turkey-related topics}} for an example.

abovestyle
belowstyle
(or above_style, top-style; below_style, bottom-style) 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:
background:#nnnnnn;
text-align:[left/center/right];

Other

state
Defaults to autocollapse. If set to collapsed, the navbox will always start out in a collapsed state. If set to blank or anything other than autocollapse or collapsed, the navbox will always start out in an expanded state. A navbox with autocollapse will start out collapsed if there are two or more tables on the same page that use collapsible. For the technically minded, see MediaWiki:Common.js.
To specify different states for transcluding articles, set state to {{{state<includeonly>|autocollapse</includeonly>}}}. Then, in an article, set this parameter to a value described above. For example, {{templateName|state=}} will expand the template.

Layout of table


Table generated by {{Navbox generic}} without image, above and below parameters (borders added for illustration only):


v
t
e{{{title}}}


{{{group1}}}

{{{list1}}}


{{{group2}}}

{{{list2}}}


{{{list3}}} without {{{group3}}}



Table generated by {{Navbox generic}} with image, above and below parameters (borders added for illustration only):


v
t
e{{{title}}}


{{{above}}}


{{{group1}}}

{{{list1}}}

{{{image}}}


{{{group2}}}

{{{list2}}}


{{{list3}}} without {{{group3}}}


{{{below}}}

Example with code




{{Navbox generic
|name      = {{subst:PAGENAME}}
|state     = {{{state|uncollapsed}}}
|title     = Navigational templates
|bodystyle = width:50%;

|group1    = Physics
|list1     = [[Template:Cosmology|Cosmology]]{{·}} [[Template:General relativity|Relativity]]{{·}}
[[Template:String-theory|String theory]]

|group2    = Continents
|list2     = <div>
[[Template:Africafooter|Africa]]{{·}}
[[Template:Asiafooter|Asia]]{{·}}
[[Template:Europefooter|Europe]]
</div>

|list3     = [[Template:National parks of Argentina|Argentinian National Parks]]
}}


v
t
e
Navigational templates
  
Physics
Cosmology ·  Relativity ·  String theory
 
Continents

Africa · 
Asia · 
Europe


 

Argentinian National Parks

Additional examplesNo image


v
t
e
MSC (Multimedia Super Corridor) Malaysia
without image
  
Centre
Cyberjaya
 
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


v
t
e
MSC (Multimedia Super Corridor) Malaysia
with image
  
Centre
Cyberjaya

 
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 and styles


v
t
e
MSC (Multimedia Super Corridor) Malaysia
with image; body (lists): white background; groups: top and right-aligned, don't wrap white space; even rows: light grey background; bottom: center-aligned, light blue background
  
Centre
Cyberjaya

 
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
                
 Website: www.msc.com.my

v t e {{{title}}}
{{{group1}}}	{{{list1}}}
{{{group2}}}	{{{list2}}}
{{{list3}}} without {{{group3}}}

v t e {{{title}}}
{{{above}}}
{{{group1}}}	{{{list1}}}	{{{image}}}
{{{group2}}}	{{{list2}}}
{{{list3}}} without {{{group3}}}
{{{below}}}

v t e Navigational templates
Physics	Cosmology · Relativity · String theory
Continents	Africa · Asia · Europe
Argentinian National Parks

v t e MSC (Multimedia Super Corridor) Malaysia without image
Centre	Cyberjaya
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