Template:Navbar/doc

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

This template is used on 5,000,000+ pages, or roughly 2124% of all pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

Usage

General

Copyable examples when inside a given template adds navbar navigational functionality:

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

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

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

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

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

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.

{{navbar|navbar/doc}} gives:

Deprecated parameters

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

Examples

Required parameters

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

Optional parameters

Options	Parameters	Produces...
Normal	`{{navbar\|Template Name}}`	This box: view talk edit
No "This box:" text.	`{{navbar\|Template Name\|plain=1}}`	view talk edit
Short version.	`{{navbar\|Template Name\|mini=1}}`	v t e
Good for "blending" into text.	`{{navbar\|Template Name\|nodiv=1}}`	Lorem This box: view talk edit Ipsum
Blended, no "This box:" text.	`{{navbar\|Template Name\|plain=1\|nodiv=1}}`	Lorem view talk edit Ipsum
Blended, short version.	`{{navbar\|Template Name\|mini=1\|nodiv=1}}`	Lorem v t e Ipsum
For a color option.	`{{navbar\|Template Name\|fontstyle=color:green}}`	This box: view talk edit
With brackets.	`{{navbar\|Template Name\|brackets=1}}`	This box: view talk edit

Prepackaged

{{Tnavbar-header}}: Positions v • d • e on the right edge of the line, often used in non-collapsible navbox heading.
{{Tnavbar-navframe}}: For use in conjunction with Navframe divs, positions v • d • e opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}: For use in conjunction with Collapsible tables,floats v • d • e opposite of the [hide]/[show] feature.

Template	Collapsible	Image	Groups	Style (body) parameter/s
{{Navbox}}	collapsible	Left/right of body	Yes	Yes
{{Navbox with collapsible groups}}	collapsible	Left/right of body and/or in each list	Yes	Yes
{{Navbox with columns}}	collapsible	Left/right of columns	No	Yes