Template:Navbar/doc: Difference between revisions
FantasyTeddy (talk | contribs) (Created page with "{{documentation subpage}} {{lua}} ==Usage== ===General=== When one of the following examples is placed inside a given template, it adds nav...") |
FantasyTeddy (talk | contribs) mNo edit summary |
||
Line 50: | Line 50: | ||
==See also== | ==See also== | ||
{{Navigation templates}} | {{Navigation templates}} | ||
Latest revision as of 13:10, 3 August 2015
Please see wp:Lua and mw:Extension:Scribunto to learn more.
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}}
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.
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.
{{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
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 |