Template:NavigationBox

From Wikipedia, the free encyclopedia

{{{Title}}} {{{Image}}}
{{{List}}}


[edit] Template documentation
This documentation is transcluded from Template:NavigationBox/doc. (edit | history)
The template {{NavigationBox}} is deprecated. Please use {{NavigationBox}} instead.
This usage is deprecated. Please replace it with {{tdeprecated|NavigationBox|NavigationBox}}.
The template {{NavigationBox}} is deprecated. Please use {{Navbox}} instead.

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
 | Name = {{subst:PAGENAME}}
 | Title = 
 | Image = 
 | List = 
 | Category = 
 | Summary = 
}}

Parameters

Mandatory

Name 
Name of the template, include for future use when Tnavbar functionality is added.
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. Where it is used, care and consensus are needed as multiple navigational templates on one page with different titlebar colors will probably look unpleasant.
Image 
The image. Must include [[Image:...|?px|alt text]]
Category 
Category list. List categories the template is classified into. Must be specified as wiki text e.g.
| Category = [[Category:Category One]][[Category:Category Two]]
A suggested starting point for finding a suitable category is Category:Navbox (navigational) templates.
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
| Name = US Presidents
| Title = The first 25 Presidents of the United States
| Image = [[Image:Seal Of The President Of The Unites States Of America.svg|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:

The first 25 Presidents of the United States U.S. presidential seal
Washington • J Adams • Jefferson • Madison • Monroe • JQ Adams • Jackson • Van Buren • W Harrison • Tyler • Polk • Taylor • Fillmore • Pierce • Buchanan • Lincoln • A Johnson • Grant • Hayes • Garfield • Arthur • Cleveland • B Harrison • Cleveland • McKinley

Example 2

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

The first 25 Presidents of the United States
Washington • J Adams • Jefferson • Madison • Monroe • JQ Adams • Jackson • Van Buren • W Harrison • Tyler • Polk • Taylor • Fillmore • Pierce • Buchanan • Lincoln • A Johnson • Grant • Hayes • Garfield • Arthur • Cleveland • B Harrison • Cleveland • McKinley

See also

Navigation template comparison
view • talk • edit
 collapsible Header color Image Groups Style (body)
parameter/s		 Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes {{USCongress}}, {{Solar System}}
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes {{Current U.S. Senators}}, {{Czech lands}}
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes {{University of Michigan}}, {{Scouting}}
Collapsible attributes
Type CSS classes Javascript Collapses when Custom
initial state		 Nesting
Collapsible tables collapsible Defined in Common.js 2 or more autocollapse on page Yes Yes
Commons