Template:Navbar
Usage
General
When one of the following examples is placed inside a given template, it adds navbar navigational functionality:
- {{navbar|{{subst:PAGENAME}}|mini=1}}
- {{navbar|{{subst:PAGENAME}}|plain=1}}
- {{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
{{subst:PAGENAME}}
will be substituted with the template's name when parsed by the servers. For example, {{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|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=1}} |
|
Short version | {{navbar|Template Name|mini=1}} |
|
With brackets | {{navbar|Template Name|brackets=1}}
|
|
With a color option (span) | {{navbar|Template Name|fontstyle=color:green}} |
|
To float to the side (div) | {{navbar|Template Name|style=float:right}} |
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To implement the view-only version, use the {{v}} or {{view}} templates instead.
Notes
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
- {{Navbar-header}}
- Positions on the right edge of the line, often used in non-collapsible navbox heading.
- {{Tnavbar-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
Collapsible | Header color | Image | Groups | Style (body) parameter/s | |
---|---|---|---|---|---|
{{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 |
{{Navbox years}} | collapsible | navbox | No | No | No |
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> {
"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. (edit | history) Editors can experiment in this template's sandbox (create | mirror) and testcases (create) pages. Please add categories to the /doc subpage. Subpages of this template. |