Plantilla:Navbar/doc
This is a documentation subpage for Plantilla:Navbar. It contains usage information, categories and other content that is not part of the original plantilla page. |
This template is used on approximately 9 140 000 pages, or roughly 108784% of all pages. 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. Consider discussing changes on the talk page before implementing them. Tranclusion count updated automatically (see documentation). |
This plantilla is used in system messages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid large-scale disruption, any changes should first be tested in this plantilla's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this plantilla. Please discuss any 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 Plantilla:Lang 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
revisaGeneral
revisaWhen 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
revisaFont-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 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.
Examples
revisaRequired parameters
revisa{{navbar|Template Name}}
– the template name is required.
Optional parameters
revisaOptions | 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=float:right; background: Beige; padding: 5px; border: 1px solid;}} |
Shortcut templates
revisaThe 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
revisaNavbar 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
revisa- {{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.
See also
revisa- {{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}} – plain talk link
- {{Watch}} – plain link that adds the page to your watchlist
- Category:Internal template-link templates
Collapsible | Header color | Image | Groups | Style (body) parameter/s |
Examples | |
---|---|---|---|---|---|---|
{{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes | |
{{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes |
|
{{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes |
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 |
TemplateData
revisaTemplateData for Navbar
When placed inside a given template, it adds navbar navigational functionality
Parámetro | Descripción | Tipo | Estado | |
---|---|---|---|---|
Template Name | 1 | The name of the template, so links work correctly
| Cadena | obligatorio |
Different text | text | Allows custom text to replace the default 'this box'
| Cadena | opcional |
Without 'This box:' text | plain | Removes 'This box'
| Número | opcional |
Short Version | mini | Shortens text to V T E
| Número | opcional |
with brackets | brackets | adds brackets before and after the links
| Número | opcional |
Font color | fontstyle | Allows you to change the color of the font (in the format color:green)
| Cadena | opcional |
To float to the side | style | Allows the template to float to the side (format=float:right)
| Cadena | opcional |