Template:Navbox generic/doc

From Wikipedia, the free encyclopedia

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

[edit] Blank template

{{Navbox generic
|name       = {{subst:PAGENAME}}
|navbar     =
|state      = 
|titlestyle = 
|title      = 
|image      = 
|bodystyle  = <!-- (or "style =" if no other style parameters used) -->
|groupstyle = 
|liststyle  = 
|oddstyle   = 
|evenstyle  = 

|abovestyle = 
|above = 

|group1 = 
|list1  = 

|group2 = 
|list2  = 

 ...

|group20 = 
|list20  = 

|belowstyle = 
|below = 
}}

[edit] Parameters

[edit] Mandatory

name

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).

[edit] Optional

[edit] 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

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

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}}.

[edit] Styles

titlestyle

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;

width:N [em/%/px];

float:[left/right/none];

clear:[right/left/both/none];

groupstyle

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

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 topics}} for an example.

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:

background:#nnnnnn;

text-align:[left/center/right];

[edit] 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.

titlestyle = background:#ccccff; text-align:center;

bodystyle = background:#f9f9f9; width:100%; text-align:center; vertical-align:middle;

groupstyle = background:#ddddff;

liststyle = background:transparent;

oddstyle = background:transparent;

evenstyle = background:transparent;

abovestyle = background:transparent;

belowstyle = background:transparent;

Since all but groupstyle and titlestyle have transparent background and no text-align all others inherit the bodystyle, which defaults to a light gray background and centered text: background:#f9f9f9; text-align:center; vertical-align:middle;.

[edit] Other

state

Variables = expand | collapsed | autocollapse. The default is set 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.

Often times, editors will want a default initial state for a nav box, which may be overridden in an article. Here is the trick to do this:

In your intermediate template, create a parameter also named "state" as a pass-through like this

| state = {{{state<includeonly>|your_desired_initial_state</includeonly>}}}

Example: {{peso}} with autocollapse as the default initial state. Bolivian peso transcludes it and has only one nav box. So the peso nav box shows. Chilean peso has two nav boxes. So the peso nav box collapses.

Example: {{Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.

The <includeonly>| will make the template expanded when viewing the template page by itself.

navbar

Defaults to Tnavbar. If set to plain, the

v • d • e

links on the left side of the titlebar will not be displayed.

[edit] Layout of table

[edit] Example with code

{{Navbox generic
|name      = {{subst:PAGENAME}}
|state     = {{{state|uncollapsed}}}
|title     = [[Wikipedia:Navigational templates|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]]
}}

[edit] Additional examples

[edit] No image

[edit] With image

v • d • 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

[edit] With image and styles

v • d • 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

[edit] See also

• {{·}} and {{•}} - The dots and bullets usually used in the link lists in the navboxes.