Template:NavigationBox/doc
From Wikipedia, the free encyclopedia
 |
This is the template documentation page for Template:NavigationBox. This page is not necessarily intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs. |
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 |
[edit] Blank
{{NavigationBox
| Name = {{subst:PAGENAME}}
| Title =
| Image =
| List =
| Category =
| Summary =
}}
[edit] Parameters
[edit] 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.
[edit] 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]]
- 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”.
[edit] Examples
[edit] Example 1
The following code:
{{NavigationBox
| Name = US Presidents
| 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:
| 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 |
[edit] 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 |
[edit] See also
| collapsible | Header color† | Image | Groups | Style parameter |
Example | |
|---|---|---|---|---|---|---|
| {{Navigation}} | NavFrame | NavHead | No | No | No | {{OPEC}} |
| {{Navigation with image}} | NavFrame | NavHead | Left/right of body | No | No | {{HolmesNovels}} |
| {{Navigation with columns}} | NavFrame | NavHead | No | No | No | |
| {{Dynamic navigation box}} | collapsible | navbox | No | No | Yes | {{CSUHeads}} |
| {{Dynamic navigation box with image}} | NavFrame | NavHead | Upper left | No | No | {{SlovakPMs}} |
| {{Navbox generic}} | collapsible | navbox | Right-hand side | Yes | Yes | {{Dilbert}} |
| {{Navbox generic with image}} | collapsible | navbox | Right-hand side | Yes | Yes | {{Jewish life}} |
| {{NavigationBox}} | No | navbox | Right of title+body | No | No | {{EPA}} |
| {{Commons:NavigationBox}} | No | #ccccff | Right of title+body | No | No | |
| {{Commons:Dynamic navigation box}} | NavFrame | #ccccff | No | No | No | |
| {{Commons:Dynamic navigation box with image}} | NavFrame | #ccccff | Upper left | No | No | |
| † The background color for the header or title is inherited from the class listed below. The templates have titlebkg parameters that override the default. | ||||||
| Type | CSS classes | Collapses when | Custom initial state |
Nesting | Header color |
Font size |
|---|---|---|---|---|---|---|
| NavFrame div | NavFrame, NavHead, NavContent | 3+ of the same | No | Yes | #ccccff | 95% |
| Collapsible table | collapsible, navbox | 2+ of the same | Yes | No | #ccccff | 90% |
|
For the technically minded, see Common.css and Common.js. |
||||||
