Difference between revisions of "Template:Navbar/doc"
m |
m (1 revision) |
(No difference)
|
Latest revision as of 00:32, 19 January 2014
40x40px | This template is used on 7,180,000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
Contents
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 Tidy 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
- {{Ed}} – navbar style edit link
- {{Ed right}} – navbar style edit link aligned to right of page
- {{Edit}} – plain edit link
- {{Edit section}} – edit link aligned to right of page
- {{Navbar}} – with additional links
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 | |
{{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 |
When placed inside a given template, it adds navbar navigational functionality
Parameter | Description | Type | Default | Status | |
---|---|---|---|---|---|
Template Name | _empty_ | The name of the template, so links work correctly | string | empty | required |
Different text | text | Allows custom text to replace the default 'this box' | string | This box | optional |
Without 'This box:' text | plain | Removes 'This box' | number | 0 | optional |
Short Version | mini | Shortens text to V T E | number | 0 | optional |
with brackets | brackets | adds brackets before and after the links | number | 0 | optional |
Font color | fontstyle | Allows you to change the color of the font (in the format color:green) | string | empty | optional |
To float to the side | style | Allows the template to float to the side (format=float:right) | string | float:left | optional |