Template:Navbar/doc

This is a documentation subpage for Template:Navbar.
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.

This template is used on 7,300,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in the template's /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added in one single edit to the template. Please consider discussing any changes on the talk page before implementing them.

Usage[edit]

General[edit]

When one of the following examples is placed inside a given template, it adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=1}}

{{navbar|{{subst:PAGENAME}}|plain=1}}

{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. For example, {{navbar|navbar/doc}} gives:

Font-size[edit]

Font-size is 88% when used in a navbar, and 100% when nested in a navbox. In the navbar, the weight is "normal"; when nested in navbox, it takes on the outer setting. The middot is bold.

Examples[edit]

Required parameters[edit]

{{navbar|Template Name}} – the template name is required.

Optional parameters[edit]

Options	Parameters	Produces...
Basic	`{{navbar\|Template Name}}`	This box: view talk edit
Different text	`{{navbar\|Template Name\|text=This template:}}`	This template: view talk edit
Without "This box:" text	`{{navbar\|Template Name\|plain=1}}`	view talk edit
Short version	`{{navbar\|Template Name\|mini=1}}`	v t e
With brackets	`{{navbar\|Template Name\|brackets=1}}`	This box: [ view talk edit ]
With a color option (span)	`{{navbar\|Template Name\|fontstyle=color:green}}`	This box: view talk edit
To float to the side (div)	`{{navbar\|Template Name\|style=float:right}}`	This box: view talk edit

Deprecated parameters[edit]

The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To implement the view-only version, use the {{v}} or {{view}} templates instead.

Notes[edit]

Navbar is contained within a <div>...</div> in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a <span>...</span> or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements.

Prepackaged[edit]

{{Navbar-header}}

Positions on the right edge of the line, often used in non-collapsible navbox heading.

{{Tnavbar-navframe}}

For use in conjunction with Navframe divs, positions opposite of the [hide]/[show] feature.

{{Navbar-collapsible}}

For use in conjunction with Collapsible tables, floats opposite of the [hide]/[show] feature.

See also[edit]

{{Ed}} – navbar style edit link
{{Ed right}} – navbar style edit link aligned to right of page
{{Edit}} – plain edit link
{{Edit section}} – edit link aligned to right of page

With additional links:

{{Navbar}}

Navigation templates comparison
view talk edit	Collapsible	Header color	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{Solar System}} {{Governance of Greater London}}
{{Navbox with collapsible groups}}	collapsible	navbox	Left/right of body and/or in each list	Yes	Yes	{{Scouting}} {{University of Michigan}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Current U.S. Senators}} {{Historical regions of the Czech Republic}}
{{Navbox years}}	collapsible	navbox	No	No	No	{{Wimbledon tournaments}}

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