Difference between revisions of "Template:Navbar/doc"
From BESA® Wiki
(high-risk 7709454) |
(update obsolete HTML) |
||
| Line 6: | Line 6: | ||
===General=== | ===General=== | ||
When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | When one of the following examples is placed inside a given [[Wikipedia:Navigation templates|template]], it adds navbar navigational functionality: | ||
| − | :< | + | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></code> |
| − | :< | + | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></code> |
| − | :< | + | :<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></code> |
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}} | 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}} | ||
| Line 42: | Line 42: | ||
===Deprecated parameters=== | ===Deprecated parameters=== | ||
| − | The < | + | The <code>miniv=1</code>, <code>viewplain=1</code>, <code>nodiv=1</code> and <code>fontcolor=</code> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead. |
== Notes == | == Notes == | ||
Revision as of 16:30, 5 December 2014
Script error
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:
Script error
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}} |
Script error |
| Different text | {{navbar|Template Name|text=This template:}} |
Script error |
| Without "This box:" text | {{navbar|Template Name|plain=1}} |
Script error |
| Short version | {{navbar|Template Name|mini=1}} |
Script error |
| With brackets | {{navbar|Template Name|brackets=1}}
|
Script error |
| With a color option (span) | {{navbar|Template Name|fontstyle=color:green}} |
Script error |
| To float to the side (div) | {{navbar|Template Name|style=float:right}} |
Script error |
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 Script error on the right edge of the line, often used in non-collapsible navbox heading.
- {{Navbar-navframe}}
- For use in conjunction with Navframe divs, positions Script error opposite of the [hide]/[show] feature.
- {{Navbar-collapsible}}
- For use in conjunction with Collapsible tables, floats Script error opposite of the [hide]/[show] feature.
See also
Script error
- {{Ed}} – navbar style edit link
- {{Ed right}} – navbar style edit link aligned to right of page
- {{Edit}} – plain edit link
- {{Edit section}} – edit link aligned to right of page
- {{Navbar}} – with additional links
- {{Vedit}} – edit with the Visual Editor
Template:Navigational templates
<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>
