Difference between revisions of "Template:Navbar/doc"

Revision as of 18:10, 1 June 2015 (view source) Murph (talk | contribs) m (Add {{En-WP attribution notice}}, and a little bit of cleanup) ← Older edit		Latest revision as of 20:44, 7 June 2015 (view source) Murph (talk | contribs) m (Add {{high-risk}})
Line 1:		Line 1:
	{{documentation subpage}}		{{documentation subpage}}
		+	<includeonly>{{high-risk}}</includeonly>
	{{En-WP attribution notice}}		{{En-WP attribution notice}}

---

Latest revision as of 20:44, 7 June 2015

Error creating thumbnail: /bin/bash: rsvg-convert: command not found

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 uses material from the Wikipedia template Template:Navbar/doc, which is released under the Creative Commons Attribution-ShareAlike 3.0 Unported License (view authors).

Error creating thumbnail: /bin/bash: rsvg-convert: command not found

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}}	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 t e
With brackets	{{navbar|Template Name|brackets=1}}	This box: [ view talk edit ]
With a color option (span)	{{navbar|Template Name|fontstyle=color:green}}	This box: view talk edit
To float to the side (div)	{{navbar|Template Name|style=float:right}}	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 in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a span or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

See also

Template:Edit templates

Navigation templates comparison

view talk edit	Collapsible	Header color	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{Demo parts}} {{Stock craft}} {{Versions}} {{Solar System}} {{Governance of Greater London}}
{{Navbox with collapsible groups}}	collapsible	navbox	Left/right of body and/or in each list	Yes	Yes	{{Kerbals}} {{Parts}} {{Universe navboxes}} {{Scouting}} {{University of Michigan}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Celestial Bodies}} {{Kerbals}} {{Current U.S. Senators}} {{Historical regions of the Czech Republic}}

Collapsible attributes

Type	CSS classes	JavaScript	Collapses when	Custom initial state	Nesting
Collapsible tables	collapsible	Defined in Common.js	2 or more autocollapse on page	Yes	Yes

<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>