Template:Navbar/doc View history

Revision as of 17:55, 10 February 2016

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.

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:
This box: view · talk · edit

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}}`	This box: view · talk · edit
Different text	`{{navbar\|Template Name\|text=This template:}}`	This template: view · talk · edit
Without "This box:" text	`{{navbar\|Template Name\|plain=1}}`	view · talk · edit
Short version	`{{navbar\|Template Name\|mini=1}}`	v · d · e
With a color option	`{{navbar\|Template Name\|fontstyle=color:green}}`	This box: view · talk · edit
With brackets	`{{navbar\|Template Name\|brackets=1}}`	This box: [view · talk · edit]

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

{{Tnavbar-header}}: Positions v · d · e on the right edge of the line, often used in non-collapsible navbox heading.
{{Tnavbar-navframe}}: For use in conjunction with Navframe divs, positions v · d · e opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}: For use in conjunction with Collapsible tables, floats

<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 4: / Line 4: @@
 == Usage ==
 ===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 [[Help: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}}
@@ Line 30: / Line 30: @@
 |-
 | Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
+|-
+| With a color option || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
 |-
 | 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}}
 |}
@@ Line 44: / Line 42: @@
 == 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.
+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-header}}: Positions <small>v{{·}}d{{·}}e</small> 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|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe divs]], positions <small>v{{·}}d{{·}}e</small> 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.
+;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]], floats
-== See also ==
-{{Edit templates}}

Search