Template:Navbar/doc: Difference between revisions
(there is a significantly larger number of usages of this template across the project. The current 17% only represents :en:) |
CitadelCore (talk | contribs) m (1 revision imported) |
Latest revision as of 13:49, 26 July 2017
This is a documentation subpage for Template:Navbar. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on 7,150,000+ pages, which is 317,667% of all English Wikipedia 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 subpage. The tested changes can then be added to this page in a single edit. Please consider discussing any changes on the talk page before implementing them. |
Uses Lua: |
Usage[edit source]
General[edit source]
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[edit source]
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[edit source]
Required parameters[edit source]
{{navbar|Template Name}}
– the template name is required.
Optional parameters[edit source]
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[edit source]
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[edit source]
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[edit source]
- {{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[edit source]
- {{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
- {{Vedit}} – edit with the Visual Editor
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 |
TemplateData[edit source]
See the monthly error report for this template.
TemplateData for Navbar
When placed inside a given template, it adds navbar navigational functionality
Parameter | Description | Type | Status | |
---|---|---|---|---|
Template Name |
| 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 |