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 used on 109,000+ 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. |
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.
{{navbar|navbar/doc}} gives:
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 | |
| {{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 |