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 transcluded in one or more cascade-protected pages, so only administrators can edit it. |
 | 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 OS-Tan Collections Wiki, 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:
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> 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> tags, and therefore, any surrounding markup cannot include <span> tags, which would cause a div-span-flip lint error.
Examples
Required parameters
{{navbar|Template Name}}– the template name is required.
Optional parameters
| Options | Parameters | Produces... |
|---|---|---|
| Basic | {{navbar|Template Name}} |
|
| Different text | {{navbar|Template Name|text=This template:}} |
|
| Without "This box:" text | {{navbar|Template Name|plain=y}} |
|
| Short version | {{navbar|Template Name|mini=y}} |
|
| 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=float:right; background: Beige; padding: 5px; border: 1px solid;}} |
|
| History, move, and watchlist links | {{navbar|template=Template Name|e|t|h|m|w}} |
Note that to show the history, move, and watchlist links, template needs to be set to the template value specifically. Individual values can be left out of this list, e.g. {{navbar|template=Template Name|h|m|w}} will only show the view, history, move, and watchlist links.
Notes
Navbar is contained within a <div> in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a <span> or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.