Template:Navbar/doc
This is a documentation subpage for Template:Navbar. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
This template is used on 6,690,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. |
Uses Lua: |
Usage
[सम्पादन]General
[सम्पादन]When one of the following examples is placed inside a given template, it adds 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 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. 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).
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=y}} |
|
Short version | {{navbar|Template Name|mini=y}} |
|
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;}} |
Deprecated parameters
[सम्पादन]The miniv=y
, viewplain=y
, nodiv=y
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.
- {{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
[सम्पादन]- {{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 |
TemplateData
[सम्पादन]TemplateData for Navbar
When placed inside a given template, it adds navbar navigational functionality
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template Name | 1 | The name of the template, so links work correctly
| String | required |
Different text | text | Allows custom text to replace the default 'this box'
| String | optional |
Without 'This box:' text | plain | Removes 'This box'
| Number | optional |
Short Version | mini | Shortens text to V T E
| Number | optional |
with brackets | brackets | adds brackets before and after the links
| Number | optional |
Font color | fontstyle | Allows you to change the color of the font (in the format color:green)
| String | optional |
To float to the side | style | Allows the template to float to the side (format=float:right)
| String | optional |