साँचा:Navbar/doc
साँचा:documentation subpage साँचा:high-risk
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:
साँचा:navbar
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}} |
साँचा:navbar |
| Different text | {{navbar|Template Name|text=This template:}} |
साँचा:navbar |
| Without "This box:" text | {{navbar|Template Name|plain=1}} |
साँचा:navbar |
| Short version | {{navbar|Template Name|mini=1}} |
साँचा:navbar |
| With brackets | {{navbar|Template Name|brackets=1}}
|
साँचा:navbar |
| With a color option (span) | {{navbar|Template Name|fontstyle=color:green}} |
साँचा:navbar |
| To float to the side (div) | {{navbar|Template Name|style=float:right}} |
साँचा:navbar |
Deprecated parameters
The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To implement the view-only version, use the साँचा:tlx or साँचा:tlx templates instead.
Notes
Navbar is contained within a साँचा:tag in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a साँचा:tag or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.
Prepackaged
- साँचा:tl
- Positions साँचा:navbar on the right edge of the line, often used in non-collapsible navbox heading.
- साँचा:tl
- For use in conjunction with Navframe divs, positions साँचा:navbar opposite of the [hide]/[show] feature.
- साँचा:tl
- For use in conjunction with Collapsible tables, floats साँचा:navbar opposite of the [hide]/[show] feature.
See also
| collapsible | Header color† | Image | Groups | Style (body) parameter/s |
Examples | |
|---|---|---|---|---|---|---|
| साँचा:tl | साँचा:yes2 collapsible |
navbox | साँचा:yes2 Left/right of body | साँचा:yes | साँचा:yes | साँचा:tl, साँचा:t1 |
| साँचा:tl | साँचा:yes2 collapsible |
navbox | साँचा:yes2 Left/right of columns | साँचा:no | साँचा:yes | साँचा:t1, साँचा:tl |
† 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, navbox | 2 or more autocollapse on page | साँचा:yes | साँचा:yes | #ccccff | 90% |
When placed inside a given template, it adds navbar navigational functionality
| प्राचल | वर्णन | प्रकार | स्थिति | |
|---|---|---|---|---|
| Template Name | | The name of the template, so links work correctly
| स्ट्रिंग | आवश्यक |
| Different text | text | Allows custom text to replace the default 'this box'
| स्ट्रिंग | वैकल्पिक |
| Without 'This box:' text | plain | Removes 'This box'
| संख्या | वैकल्पिक |
| Short Version | mini | Shortens text to V T E
| संख्या | वैकल्पिक |
| with brackets | brackets | adds brackets before and after the links
| संख्या | वैकल्पिक |
| Font color | fontstyle | Allows you to change the color of the font (in the format color:green)
| स्ट्रिंग | वैकल्पिक |
| To float to the side | style | Allows the template to float to the side (format=float:right)
| स्ट्रिंग | वैकल्पिक |