Template:NavigationBox

From Wikipedia, the free encyclopedia

This template documentation is transcluded from Template:NavigationBox/doc [edit]


This is a navigational template. It helps to construct a standardized box containing a list of links to articles which relates to the one being read, plus an optional image.

Contents

Blank

{{NavigationBox
 | Title = 
 | Image = 
 | List = 
 | Category = 
 | Summary = 
}}

Parameters

Mandatory

Title
Text that appears centered in the titlebar (the top bar). Usually this is the template's topic, i.e. a succinct description of the body contents.
List
Contents of the navigation box. Use | to separate links. It is not possible to include a pipe ("|") in the contents as this symbol is used to separate parameters.

Optional

Color
Header color. Default is #ccf. Use of this parameter is discouraged. Care/consensus needed when using this parameter as multiple navigational templates on one page using different titlebar colors is likely to look unpleasant.
Image
The image. Must include [[Image:...|?px|alt text]]
Summary
this parameter is aimed at vocal and Braille-based user agents and should give a brief textual description of the box contents; ordinary quotation marks around or within the provided text are not allowed; if quoting is needed you may use curly quotes: and .

Examples

Example 1

The following code:

{{NavigationBox
| Title = The first 25 Presidents of the United States
| Image = [[Image:USPresidentialSeal.jpg|60px|U.S. presidential seal]]
| Summary = A list of the first 25 US Presidents
| Color =
| Category =
| List = [[George Washington|Washington]] • [[John Adams|J Adams]] • [[Thomas Jefferson|Jefferson]] • [[James Madison|Madison]] • [[James Monroe|Monroe]] • [[John Quincy Adams|JQ Adams]] • [[Andrew Jackson|Jackson]] • [[Martin Van Buren|Van Buren]] • [[William Henry Harrison|W Harrison]] • [[John Tyler|Tyler]] • [[James K. Polk|Polk]] • [[Zachary Taylor|Taylor]] • [[Millard Fillmore|Fillmore]] • [[Franklin Pierce|Pierce]] • [[James Buchanan|Buchanan]] • [[Abraham Lincoln|Lincoln]] • [[Andrew Johnson|A Johnson]] • [[Ulysses S. Grant|Grant]] • [[Rutherford B. Hayes|Hayes]] • [[James Garfield|Garfield]] • [[Chester A. Arthur|Arthur]] • [[Grover Cleveland|Cleveland]] • [[Benjamin Harrison|B Harrison]] • [[Grover Cleveland|Cleveland]] • [[William McKinley|McKinley]]
}}

yields:

Example 2

Removing the Image argument and providing Color= teal the result changes to:

See also

Collapsible Image Groups Header color Custom table style Real example
{{Navigation}} Yes, with NavFrame No No #efefef, overridable No {{OPEC}}
{{Navigation with image}} Yes, with NavFrame Yes, resizable, left or right to the body No #efefef, overridable No {{Arab League}}
{{Dynamic navigation box}} Yes, with collapsible No No #ccf, overridable Yes {{CSUHeads}}
{{Dynamic navigation box with image}} Yes, with NavFrame Yes, resizable, upper left No #efefef, overridable No {{SPDHeads}}
{{Navbox generic}} Yes, with collapsible No Yes #ccf, overridable Yes {{Dilbert}}
{{NavigationBox}} No Yes, right to both header and body No #ccf, overridable No {{GermanPresidents}}
{{NavigationBox}} Broken
{{Dynamic navigation box}} Yes, with NavFrame No No #ccccff, overridable No
{{Dynamic navigation box with image}} Yes, with NavFrame Yes, resizable, upper left No #efefef, overridable No
autocollapse logic custom initial state hide/show button position
NavFrame 4 or more of the same No Right
collapsible 2 or more of the same Yes Left

{{NavigationBox}} (Image breaks titlebar; template deprecated? David Kernow (talk) 02:23, 29 November 2006 (UTC))