模板:Navbar/doc
This is a documentation subpage for 模板:Navbar. It contains usage information, categories and other content that is not part of the original 模板 page. |
This template is used on 7,800,000+ pages, which is 2,025,974% 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 one single edit. 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... | "Shortcut" template |
---|---|---|---|
Basic | {{navbar|Template Name}} |
||
Different text | {{navbar|Template Name|text=This template:}} |
||
Without "This box:" text | {{navbar|Template Name|plain=y}} |
模板:T | |
Short version | {{navbar|Template Name|mini=y}} |
模板:T | |
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;}} |
Shortcut templates
The mini=y
and plain=y
parameters can be avoided by using the {{v}} or {{view}} templates, respectively, 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
- {{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 templates 模板:Navigation templates
TemplateData
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)
| 字符串 | 可选 |