Template:VTE

The VTE template invokes the {{navbar}} template with the parameter mini set to 1.

For more information, see Template:Navbar/doc, which has been transcluded below for convenience.

Template:Navbar/doc

Template documentation[view] [edit] [history] [purge]

This template uses Lua:

Module:Navbar

Shortcut

{{V}}

{{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 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[edit]

General[edit]

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>...</includeonly> markup, so that it only appears when transcluded.

Font size and weight[edit]

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[edit]

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[edit]

Required parameters[edit]

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

Optional parameters[edit]

Options	Parameters	Produces...	"Shortcut" template
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=y}}`	view talk edit	{{view}}
Short version	`{{navbar\|Template Name\|mini=y}}`	v t e	{{v}}
With brackets	`{{navbar\|Template Name\|brackets=y}}`	This box: view talk edit
With font styling examples (span)	`{{navbar\|Template Name\|fontstyle=color: green; font-style: italic;}}`	This box: view talk edit
With whole-template styling examples (div)	`{{navbar\|Template Name\|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}`	This box: view talk edit
History, move, and watchlist links	`{{navbar\|template=Template Name\|e\|t\|h\|m\|w}}`	This box: view talk edit hist move watch

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.

Shortcut templates[edit]

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
template=view/doc}}	view
template=view/doc\|talk}}	view talk
template=view/doc\|talk\|edit}}	view talk edit
template=v/doc}}	v
template=v/doc\|t}}	v t
template=v/doc\|t\|e}}	v t e

Notes[edit]

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[edit]

{{Navbar-header}}

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

{{Navbar-collapsible}}

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

TemplateData[edit]

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 VTE

<templatedata> {

       "description": "When placed inside a given template, it adds navbar navigational functionality",
       "params": {
               "": {
                       "label": "Template Name",
                       "description": "The name of the template, so links work correctly",
                       "type": "string",
                       "default": "",
                       "required": true
               },
               "text": {
                       "label": "Different text",
                       "description": "Allows custom text to replace the default 'this box'",
                       "type": "string",
                       "default": "This box",
                       "required": false
                            },
               "plain": {
                       "label": "Without 'This box:' text",
                       "description": "Removes 'This box'",
                       "type": "number",
                       "default": "0",
                       "required": false

               },
               "mini": {
                       "label": "Short Version",
                       "description": "Shortens text to V T E",
                       "type": "number",
                       "default": "0",
                       "required": false
               },
               "brackets": {
                       "label": "with brackets",
                       "description": "adds brackets before and after the links",
                       "type": "number",
                       "default": "0",
                       "required": false
               },
               "fontstyle": {
                       "label": "Font color",
                       "description": "Allows you to change the color of the font (in the format color:green)",
                       "type": "string",
                       "default": "",
                       "required": false
               },
               "style": {
                       "label": "To float to the side",
                       "description": "Allows the template to float to the side (format=float:right)",
                       "type": "string",
                       "default": "float:left",
                       "required": false

                }
       }

} </templatedata>

The above documentation is transcluded from Template:Navbar/doc.
Editors can experiment in this template's sandbox and testcases pages.
Subpages of this template.

Template:VTE

Contents

Usage[edit]

General[edit]

Font size and weight[edit]

Block level element[edit]

Examples[edit]

Required parameters[edit]

Optional parameters[edit]

Shortcut templates[edit]

Notes[edit]

Prepackaged[edit]

See also[edit]

TemplateData[edit]

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Content

Community

Tools