Template:Navbar/doc

The {{Navbar}} template provides a small navigation bar with links to perform the "view · talk · edit" actions on the content transcluding it. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easier both to recognize and edit in situ where it was found, without having to track it down through examining transclusion code. The high use rate for {{Navbar}} is because it is integrated as a feature into numerous navigation box and infobox templates present on many articles. It is also a regular feature of many internal-use templates and tables in the Zoophilia Wiki, Help and Template namespaces.

Usage

General

When one of the following examples is placed inside a given navigation template (or block of content used for selective transclusion), it adds basic navbar functionality:

{{Navbar|{{subst:PAGENAME}}|mini=y}}

{{Navbar|{{subst:PAGENAME}}|plain=y}}

{{Navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}

The {{subst:PAGENAME}} will be substituted with the page name of the real location of the content when parsed by the server. For example, {{Navbar|Navbar/doc}} gives:

When used in content that is selectively transcluded, but which is also used as-is in its original location, this template should be wrapped in <includeonly>…</includeonly> markup, so that it only appears when transcluded.

Font size and weight

The standard font size is 88% (14pt) when used in a topical navbar template or in plain text, and 100% (16pt) when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the parent element's style definitions, not that of the root page). The |fontstyle= parameter can be used to adjust font size as needed (for example, to reduce the font size even more when the template is used inside a block element with already enlarged fonts). Do not abuse this to make excessively small text (a reasonable floor is anything 80% of the normal page text), since that causes accessibility problems for many readers, especially those using accessibility tools to overcome other hindrances they have with technology.

In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. Note that the middot bullets are bold for better visibility.

Examples

Required parameters

• {{Navbar|Template name}} – The template name. (required)

Optional parameters

Options	Parameters	Produces…	"Shortcut" template
Basic	{{Navbar|Template name}}
Different text	{{Navbar|Template name|text=This template:}}
Without "This box:" text	{{Navbar|Template name|plain=y}}		{{View}}
Short version	{{Navbar|Template name|mini=y}}		{{V}}
With brackets	{{Navbar|Template name|brackets=y}}
With font styling examples (span)	{{Navbar|Template name|fontstyle=color: green; font-style: italic;}}
With whole-template styling examples (div)	{{Navbar|Template name|style=background-color: beige; border-style: solid; border-width: 1px; float: right; padding: 5px;}}

Shortcut templates

The |mini=y and |plain=y parameters can be avoided by using the {{V}} or {{View}} templates, respectively, instead.

{{View}} and {{V}} also support changing the shown links, for example only 'view' and 'edit', or only 'view' and 'talk':

Code	Result
{{View|template=view/doc}}
{{View|template=view/doc|talk}}
{{View|template=view/doc|talk|edit}}
{{V|template=v/doc}}
{{V|template=v/doc|t}}
{{V|template=v/doc|t|e}}

Notes

Navbar is contained within <div>...</div> tags in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside <span>...</span> tags or any other inline elements, because the HTML Tidy extension will try to automatically "fix" situations where it finds block elements nested inside of inline ones.

Prepackaged

{{Navbar-header}}

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

{{Navbar-navframe}}

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

{{Navbar-collapsible}}

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

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.

TemplateData for Navbar

When placed inside a given template, it adds navbar navigational functionality

Template parameters

This template prefers inline formatting of parameters.

Parameter		Description	Type	Status
Template name	1	The name of the template, so links work correctly Default {{PAGENAME}}	Template	required
Custom text	text	Replaces the default 'This box' output with the value assigned here Default This box	Line	optional
Simple appearance	plain	Removes 'This box' from the output Suggested values 0 1 Default 0	Number	optional
Initialized links	mini	Shortens links to 'V' 'T' 'E' Suggested values 0 1 Default 0 Auto value 0	Number	optional
Add brackets	brackets	Encloses the links in square brackets Suggested values 0 1 Default 0	Number	optional
Custom font style	fontstyle	Add custom CSS declarations to the text output; e.g. to change the color of the font: 'color: green;'	String	optional
Custom styling	style	Add custom CSS declarations; e.g. to float to the opposite side: 'float: right;' Default float: left;	String	optional

See also

[] Compare different edit templates:

• {{Ed}} —– plain-style edit link surrounded by <small> tags, specifically for templates only
• {{Ed right}} —– plain-style edit link surrounded by <small> tags and aligned to right of page, specifically for templates only
• {{Edit}} —– plain-style edit link, applicable to all Wikipedia namespaces
• {{Edit section}} —– edit link surrounded by <div> tags by default which can specify which section to edit on a page, applicable to all Wikipedia namespaces
• {{Edit sup}} —– plain-style edit link surrounded by <sup> tags, applicable to all Wikipedia namespaces
• {{Edit sub}} —– plain-style edit link surrounded by <sub> tags, applicable to all Wikipedia namespaces
• {{Vedit}} —– plain-style edit link which edit with the Wikipedia:VisualEditor, applicable to all Wikipedia namespaces

Templates with view, talk and edit links:

• {{Navbar}} —– navigation bar with configurable caption and view·talk·edit links, specifically for templates only
• {{View}} —– navbar-style view·talk·edit links, specifically for templates only
• {{VTE}} & {{V}} —– navbar-style V·T·E links (i.e. view·talk·edit links in short forms), specifically for templates only

Other internal link templates, including:

• {{Talk}} – basic 'talk' link
• {{Watch}} – a plain link that adds the page to your watchlist.
• Internal template-link templates category

Navigation templates comparison

	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	{{Tetrapodomorpha}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Current U.S. Senators}} {{Historical regions of the Czech Republic}}

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