DarkMavis at 23:20, 15 July 2015

2015-07-15T23:20:40Z

DarkMavis: Created page with "{{documentation subpage}} {{high-risk|6,200,000+}} {{lua|Module:Navbar}} ==Usage== ===Gen..."

2015-07-15T19:56:21Z

Created page with "{{documentation subpage}} {{high-risk|6,200,000+}} {{lua|Module:Navbar}}  ==Usage== ===Gen..."

New page

{{documentation subpage}}
{{high-risk|6,200,000+}}
{{lua|Module:Navbar}}


==Usage==
===General===
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}}

===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 <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==
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 the [[HTML Tidy]] extension 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|Navbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame#NavFrame divs|NavFrame divs]], 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}}
{{Navigation templates}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
[[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>

@@ Line 1: / Line 1: @@
 {{documentation subpage}}
-{{high-risk|6,200,000+}}
-{{lua|Module:Navbar}}
 <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->

Template:Navbar/doc - Revision history

DarkMavis at 23:20, 15 July 2015

DarkMavis: Created page with "{{documentation subpage}} {{high-risk|6,200,000+}} {{lua|Module:Navbar}} ==Usage== ===Gen..."