Difference between revisions of "Template:Navbar/doc"
(←Blanked the page) |
test>JBW m (Reverted edits by 123.22.155.17 (talk) to last revision by Mdann52 (HG)) |
||
| Line 1: | Line 1: | ||
| + | {{documentation subpage}} | ||
| + | {{high-risk|7,055,000+}} | ||
| + | <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE---> | ||
| + | == Usage == | ||
| + | ===General=== | ||
| + | When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt> | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt> | ||
| + | :<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt> | ||
| + | |||
| + | The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers. For example, <code><nowiki>{{navbar|navbar/doc}}</nowiki></code> gives:<br> {{navbar|navbar/doc}} | ||
| + | |||
| + | ===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=== | ||
| + | *<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required. | ||
| + | |||
| + | ===Optional parameters=== | ||
| + | {| class="wikitable" | ||
| + | ! Options !! Parameters !! Produces... | ||
| + | |- | ||
| + | | Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}} | ||
| + | |- | ||
| + | | Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|navbar/doc|text=This template:}} | ||
| + | |- | ||
| + | | Without "This box:" text || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}} | ||
| + | |- | ||
| + | | Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}} | ||
| + | |- | ||
| + | | With brackets | ||
| + | | <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code> | ||
| + | | {{navbar|navbar/doc|brackets=1}} | ||
| + | |- | ||
| + | | With a color option ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}} | ||
| + | |- | ||
| + | | To float to the side ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|style=float:right}}</nowiki></code> || {{navbar|navbar/doc|style=float:right}} | ||
| + | |} | ||
| + | |||
| + | ===Deprecated parameters=== | ||
| + | The <tt>miniv=1</tt>, <tt>viewplain=1</tt>, <tt>nodiv=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. | ||
| + | |||
| + | == Notes == | ||
| + | Navbar is contained within a {{tag|div}} in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a {{tag|span}} or other inline element, because Tidy will 'fix' situations where it finds block elements inside inline elements. | ||
| + | |||
| + | == Prepackaged == | ||
| + | ;{{tl|Navbar-header}}: Positions {{navbar|navbar/doc|mini=1}} on the right edge of the line, often used in non-collapsible navbox heading. | ||
| + | ;{{tl|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe div]]s, positions {{navbar|navbar/doc|mini=1}} opposite of the [hide]/[show] feature. | ||
| + | ;{{tl|Navbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]], floats {{navbar|navbar/doc|mini=1}} opposite of the [hide]/[show] feature. | ||
| + | |||
| + | == See also == | ||
| + | {{Edit templates}} | ||
| + | {{Navigational templates}} | ||
| + | |||
| + | <!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE ---> | ||
| + | <includeonly> | ||
| + | [[Category:Internal link templates]] | ||
| + | </includeonly> | ||
| + | <templatedata> | ||
| + | { | ||
| + | "description": "When placed inside a given template, it adds navbar navigational functionality", | ||
| + | "params": { | ||
| + | "": { | ||
| + | "label": "Template Name", | ||
| + | "description": "The name of the template, so links work correctly", | ||
| + | "type": "string", | ||
| + | "default": "", | ||
| + | "required": true | ||
| + | }, | ||
| + | "text": { | ||
| + | "label": "Different text", | ||
| + | "description": "Allows custom text to replace the default 'this box'", | ||
| + | "type": "string", | ||
| + | "default": "This box", | ||
| + | "required": false | ||
| + | }, | ||
| + | "plain": { | ||
| + | "label": "Without 'This box:' text", | ||
| + | "description": "Removes 'This box'", | ||
| + | "type": "number", | ||
| + | "default": "0", | ||
| + | "required": false | ||
| + | |||
| + | }, | ||
| + | "mini": { | ||
| + | "label": "Short Version", | ||
| + | "description": "Shortens text to V T E", | ||
| + | "type": "number", | ||
| + | "default": "0", | ||
| + | "required": false | ||
| + | }, | ||
| + | "brackets": { | ||
| + | "label": "with brackets", | ||
| + | "description": "adds brackets before and after the links", | ||
| + | "type": "number", | ||
| + | "default": "0", | ||
| + | "required": false | ||
| + | }, | ||
| + | "fontstyle": { | ||
| + | "label": "Font color", | ||
| + | "description": "Allows you to change the color of the font (in the format color:green)", | ||
| + | "type": "string", | ||
| + | "default": "", | ||
| + | "required": false | ||
| + | }, | ||
| + | "style": { | ||
| + | "label": "To float to the side", | ||
| + | "description": "Allows the template to float to the side (format=float:right)", | ||
| + | "type": "string", | ||
| + | "default": "float:left", | ||
| + | "required": false | ||
| + | |||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </templatedata> | ||
Revision as of 10:52, 5 July 2013
| 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 9,160,000+ pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
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 Tidy 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.
- {{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
- {{Ed}} —– plain-style edit link surrounded by <small> tags, specifically for templates only
- {{Ed right}} —– plain-style edit link surrounded by <small> tags and aligned to right of page, specifically for templates only
- {{Edit}} —– plain-style edit link, applicable to all Wikipedia namespaces
- {{Edit section}} —– edit link surrounded by <div> tags by default which can specify which section to edit on a page, applicable to all Wikipedia namespaces
- {{Edit sup}} —– plain-style edit link surrounded by <sup> tags, applicable to all Wikipedia namespaces
- {{Edit sub}} —– plain-style edit link surrounded by <sub> tags, applicable to all Wikipedia namespaces
- {{Vedit}} —– plain-style edit link which edit with the Wikipedia:VisualEditor, applicable to all Wikipedia namespaces
Templates with view, talk and edit links:
- {{Navbar}} —– navigation bar with configurable caption and view·talk·edit links, specifically for templates only
- {{View}} —– navbar-style view·talk·edit links, specifically for templates only
- {{VTE}} & {{V}} —– navbar-style V·T·E links (i.e. view·talk·edit links in short forms), specifically for templates only
Template:Navigational templates
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 |