Template:Dynamic navigation box

From Wikipedia, the free encyclopedia

The template documentation below is transcluded from Template:Dynamic navigation box/doc [edit]


Contents

[edit] Blank

{{Dynamic navigation box
|name    = {{subst:PAGENAME}}
|title   =
|body    =
}}

[edit] Parameters

[edit] Mandatory

Parameter:

name (or templateName)
The name of the template, which is needed for the "view · talk · edit" links to work properly on all of the pages where the template is used on. You can enter {{subst:PAGENAME}} for this value as a shortcut.
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.
body
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

style
Specifies CSS values to apply to the template. For instance: text-align: (right|center|left|justified); width: (em, %, px, auto); float: (left|right|none); clear: (right|left|both|none); margin:...etc. This option should be used sparingly as it can lead to visual inconsistencies.
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.
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 2 or more tables on the same page that use collapsible. For the technically minded, see MediaWiki:Common.js.

[edit] Example

[edit] Code

{{Dynamic navigation box
|name    = {{subst:{{PAGENAME}}}}
|title   = [[Wikipedia:Navigational templates|Navigational templates]]
|body    = [[Template:Cosmology|Cosmology]]{{·}} [[Template:General relativity|Relativity]]{{·}}
[[Template:Continents of the world|World continents]]
}}

[edit] Result

[edit] See also

Navigation template comparison
view talk edit
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.
Collapsible attributes
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.