ފަންވަތް:Navbar/doc

This is a documentation subpage for ފަންވަތް:Navbar.
It contains usage information, categories and other content that is not part of the original ފަންވަތް page.

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

This template uses Lua:

Module:Navbar

Usage

General

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

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

Required parameters

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

Optional parameters

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

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

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 the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

Prepackaged

{{Navbar-header}}: Positions on the right edge of the line, often used in non-collapsible navbox heading.

{{Navbar-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.

Template parameters
Parameter		Description	Type	Status
Template Name	`1`	The name of the template, so links work correctly Default	String	required
Different text	`text`	Allows custom text to replace the default 'this box' Default This box	String	optional
Without 'This box:' text	`plain`	Removes 'This box' Default 0	Number	optional
Short Version	`mini`	Shortens text to V T E Default 0	Number	optional
with brackets	`brackets`	adds brackets before and after the links Default 0	Number	optional
Font color	`fontstyle`	Allows you to change the color of the font (in the format color:green) Default	String	optional
To float to the side	`style`	Allows the template to float to the side (format=float:right) Default float:left	String	optional