Template:Navbar/doc
This template is used on 6,600,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please consider discussing any changes on the talk page before implementing them. |
Contents
Usage
General
Copyable examples when inside a given template adds navbar navigational functionality:
- {{navbar|{{subst:PAGENAME}}|mini=1}}
- {{navbar|{{subst:PAGENAME}}|plain=1}}
- {{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
The {{subst:PAGENAME}}
will be substituted with the template's name when parsed by the servers.
Font-size
Font-size is 88% when used in a navbar, and 100% when nested in a navbox. In the navbar the weight is "normal"; when nested in navbox it takes on the outer setting. The middot is bold.
Examples
Required parameters
{{navbar|Name of Template}}
the template name is required.
Optional parameters
Options | Parameters | Produces... |
---|---|---|
Normal | {{navbar|Template Name}} |
|
Different text | {{navbar|Template Name|text=This template:}} |
|
No "This box:" text. | {{navbar|Template Name|plain=1}} |
|
Short version. | {{navbar|Template Name|mini=1}} |
|
For a color option. | {{navbar|Template Name|fontstyle=color:green}} |
|
With brackets. | {{navbar|Template Name|brackets=1}}
|
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the {{v}} or {{view}} templates instead.
Prepackaged
- {{Tnavbar-header}}
- Positions v · d · e on the right edge of the line, often used in non-collapsible navbox heading.
- {{Tnavbar-navframe}}
- For use in conjunction with Navframe divs, positions v · d · e opposite of the [hide]/[show] feature.
- {{Tnavbar-collapsible}}
- For use in conjunction with Collapsible tables,floats v · d · e opposite of the [hide]/[show] feature.
See also
- {{Edit}} (plain edit link)
- {{Ed}} (navbar style edit link)
- {{Ed right}} (navbar style edit link aligned to right of page)
- {{Edit section}} (edit link aligned to right of page)
With additional links:
- {{Navbar}}
Collapsible | Header color | Image | Groups | Style (body) parameter/s |
Examples | |
---|---|---|---|---|---|---|
{{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes | {{Solar System}} · {{United States Congress}} |
{{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes | {{Scouting}} · {{University of Michigan}} |
{{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes | {{Current U.S. Senators}} · {{Historical regions of the Czech Republic}} |
{{Navbox years}} | collapsible | navbox | No | No | No | {{Wimbledon tournaments}} |
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 |