Teamplaid:Navbar/doc
This is a documentation subpage for Teamplaid:Navbar. It contains usage information, categories and other content that is not part of the original teamplaid page. |
This template is used on 7,500,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. |
Usage
[deasaich an tùs]General
[deasaich an tùs]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
[deasaich an tùs]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
[deasaich an tùs]Required parameters
[deasaich an tùs]{{navbar|Template Name}}
– the template name is required.
Optional parameters
[deasaich an tùs]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
[deasaich an tùs]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
[deasaich an tùs]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
[deasaich an tùs]- {{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
[deasaich an tùs]collapsible | Header color† | Image | Groups | Style (body) parameter/s |
Examples | |
---|---|---|---|---|---|---|
{{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes | {{USCongress}}, {{Apollo program}} |
{{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes | {{Current U.S. Senators}}, {{UK subdivisions}} |
† The background color for the header or title is inherited from the class listed below. The templates have titlestyle parameters that can be used to override the default. |
Type | CSS classes | Collapses when | Custom initial state |
Nesting | Default header color |
Font size |
---|---|---|---|---|---|---|
Collapsible tables | collapsible | 2 or more autocollapse on page | Yes | Yes | #ccf | 90% |
When placed inside a given template, it adds navbar navigational functionality
Paramadair | Tuairisgeul | Seòrsa | Staid | |
---|---|---|---|---|
Template Name | 1 | The name of the template, so links work correctly
| Sreang | riatanach |
Different text | text | Allows custom text to replace the default 'this box'
| Sreang | roghainneil |
Without 'This box:' text | plain | Removes 'This box'
| Àireamh | roghainneil |
Short Version | mini | Shortens text to V T E
| Àireamh | roghainneil |
with brackets | brackets | adds brackets before and after the links
| Àireamh | roghainneil |
Font color | fontstyle | Allows you to change the color of the font (in the format color:green)
| Sreang | roghainneil |
To float to the side | style | Allows the template to float to the side (format=float:right)
| Sreang | roghainneil |