en.m.wikipedia.org
Template:Navbar
Template documentation​[​view​] [edit] [history] [purge]
This template is used in system messages, and on approximately 1,180,000 pages, or roughly 2% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
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. Please discuss changes on the talk page before implementing them.
This template uses Lua:
{{Navbar}}
provides a small "view · talk · edit" navigation bar. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easily editable in situ where it was found, without having track it down through examining transclusion code. {{Navbar}}'s extremely high use rate and consequent protection level are because it is integrated as a feature into numerous navigation box and infobox templates used in millions of articles. It is also a regular feature of many internal-use templates and tables of the Wikipedia, Help, and Template namespaces.
Usage
General
When one of the following examples is placed inside a given template (or block of content used for selective transclusion), it adds basic navbar navigational 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 servers. For example, {{navbar|Navbar/doc}} gives:
This box: viewtalkedit
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
Font-size is 88% when used in a topical navbar template or in plain text, and 100% when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the surrounding template's own content, not that of the entire page). The |fontstyle= parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size). Do not abuse this to make excessively small text (i.e. less than 85% of the normal page text), since that causes accessibility problems for many readers.
In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. The middot bullets are bold for better visibility.
Block level element
The template generates block-level markup with <div>...</div> tags, and therefore, any surrounding markup cannot include <span>...</span> tags, which would cause a div-span-flip lint error.
Examples
Required parameters
{{navbar|Template Name}} – the template name is required.
Optional parameters
OptionsParametersProduces..."Shortcut" template
Basic{{navbar|Template Name}}This box: viewtalkedit
Different text
{{navbar|Template Name|text=This template:}}
This template: viewtalkedit
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}}
This box: viewtalkedit
With font styling examples (span)
{{navbar|Template Name|fontstyle=color: green; font-style: italic;}}
This box: viewtalkedit
With whole-template styling examples (div)
{{navbar|Template Name|​style​=float:right; background: Beige; padding: 5px; border: 1px solid;}}
This box: viewtalkedit
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:
CodeResult
{{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 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 vte on the right edge of the line, often used in non-collapsible navbox heading.
{{Navbar-collapsible}}
For use in conjunction with collapsible tables, floats vte opposite of the [hide]/[show] feature.
See also
[viewedit] 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:
Navigation templates comparison viewtalkedit
TemplateCollapsibleHeader colorImageGroupsStyle (body)
parameter/s
Examples
{{Navbox}}collapsiblenavboxLeft/right of bodyYesYes
{{Navbox with collapsible groups}}collapsiblenavboxLeft/right of body and/or in each listYesYes
{{Navbox with columns}}collapsiblenavboxLeft/right of columnsNoYes
Collapsible attributes
TypeCSS classesJavaScriptCollapses whenCustom
initial state
Nesting
Collapsible tablescollapsibleDefined in Common.js2 or more autocollapse on pageYesYes
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Navbar
When placed inside a given template, it adds navbar navigational functionality
Template parameters
ParameterDescriptionTypeStatus
Template Name
The name of the template, so links work correctly
Default
Stringrequired
Different texttext
Allows custom text to replace the default 'this box'
Default
This box
Stringoptional
Without 'This box:' textplain
Removes 'This box'
Default
0
Numberoptional
Short Versionmini
Shortens text to V T E
Default
0
Numberoptional
with bracketsbrackets
adds brackets before and after the links
Default
0
Numberoptional
Font colorfontstyle
Allows you to change the color of the font (in the format color:green)
Default
Stringoptional
To float to the sidestyle
Allows the template to float to the side (format=float:right)
Default
float:left
Stringoptional
The above documentation is transcluded from Template:Navbar/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.
Last edited on 22 April 2017, at 18:49
Content is available under CC BY-SA 3.0 unless otherwise noted.
Privacy policy
Terms of Use
Desktop
 Home Random  Nearby  Log in  Settings  Donate  About Wikipedia  Disclaimers
LanguageWatchEdit