Difference between revisions of "Template:Navbar/doc"

Latest revision as of 13:23, 8 April 2016

Script error Script error

Usage

General

When one of the following examples is placed inside a given template, it adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=y}}

{{navbar|{{subst:PAGENAME}}|plain=y}}

{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}

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. The |fontstyle= parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).

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=y}}`	Script error
Short version	`{{navbar\|Template Name\|mini=y}}`	Script error
With brackets	`{{navbar\|Template Name\|brackets=y}}`	Script error
With font styling examples (span)	`{{navbar\|Template Name\|fontstyle=color: green; font-style: italic;}}`	Script error
With whole-template styling examples (div)	`{{navbar\|Template Name\|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}`	Script error

Deprecated parameters

The miniv=y, viewplain=y, nodiv=y 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.

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools.

TemplateData for Navbar/doc

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

Script error	Collapsible	Header color	Image	Groups	Style (body) parameter/s	Examples
{{Navbox}}	collapsible	navbox	Left/right of body	Yes	Yes	{{Solar System}} {{Governance of Greater London}}
{{Navbox with collapsible groups}}	collapsible	navbox	Left/right of body and/or in each list	Yes	Yes	{{Scouting}} {{University of Michigan}}
{{Navbox with columns}}	collapsible	navbox	Left/right of columns	No	Yes	{{Current U.S. Senators}} {{Historical regions of the Czech Republic}}

Difference between revisions of "Template:Navbar/doc"

Latest revision as of 13:23, 8 April 2016

Contents

Usage

General

Font-size

Examples

Required parameters

Optional parameters

Deprecated parameters

Notes

Prepackaged

See also

TemplateData

Navigation menu

Personal tools

Namespaces

Variants

Views

Actions

Search

Home

Navigation

Main topics

Categories

Tools

@@ Line 1: / Line 1: @@
 {{documentation subpage}}
-{{high-risk| 6,000,000+ }}
+{{high-risk|6,690,000+}}
+{{lua|Module:Navbar}}
 <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
-== Usage ==
+==Usage==
 ===General===
-Copyable examples when inside a given [[Wikipedia:Navigation templates|template]] adds navbar navigational functionality:
+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>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|mini=y}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|plain=y}}</nowiki></code>
-:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</nowiki></tt>
+:<code><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}</nowiki></code>
-The <code><nowiki>{{subst:PAGENAME}}</nowiki></code> will be substituted with the template's name when parsed by the servers.
+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}}
-<nowiki>{{navbar|navbar/doc}}</nowiki> gives: {{navbar|navbar/doc}}
-== Examples ==
+===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.  The {{para|fontstyle}} parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).
+==Examples==
 ===Required parameters===
-*<code><nowiki>{{navbar|Name of Template}}</nowiki></code> the template name is required.
+*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.
 ===Optional parameters===
@@ Line 21: / Line 25: @@
 ! Options !! Parameters !! Produces...
 |-
-| Normal || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
+| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|Navbar/doc}}
 |-
-| No "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
+| Different text || <code><nowiki>{{navbar|Template Name|</nowiki>'''text'''<nowiki>=This template:}}</nowiki></code> || {{navbar|Navbar/doc|text=This template:}}
 |-
-| Short version. || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
+| Without "This box:" text || <code><nowiki>{{navbar|Template Name|</nowiki>'''plain'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|plain=y}}
 |-
-| For a color option. || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
+| Short version || <code><nowiki>{{navbar|Template Name|</nowiki>'''mini'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|mini=y}}
 |-
-| With brackets.
+| With brackets || <code><nowiki>{{navbar|Template Name|</nowiki>'''brackets'''<nowiki>=y}}</nowiki></code> || {{navbar|Navbar/doc|brackets=y}}
-| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
+|-
-| {{navbar|navbar/doc|brackets=1}}
+| With font styling examples ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''fontstyle'''<nowiki>=color: green; font-style: italic;}}</nowiki></code> || {{navbar|Navbar/doc|fontstyle=color: green; font-style: italic;}}
+|-
+| With whole-template styling examples ([[Span and div|div]]) || <code><nowiki>{{navbar|Template Name|</nowiki>'''style'''<nowiki>=float:right; background: Beige; padding: 5px; border: 1px solid;}}</nowiki></code> || {{navbar|Navbar/doc|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}
 |}
 ===Deprecated parameters===
-The <tt>miniv=1</tt>, <tt>viewplain=1</tt>, <tt>nodiv=1</tt> and <tt>fontcolor=</tt> parameters have been deprecated. To use the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
+The <code>miniv=y</code>, <code>viewplain=y</code>, <code>nodiv=y</code> and <code>fontcolor=</code> parameters have been deprecated. To implement the view-only version, use the {{tlx|v}} or {{tlx|view}} templates instead.
-== Prepackaged ==
+==Notes==
-;{{tl|Tnavbar-header}}: Positions <small>v • d • e</small> on the right edge of the line, often used in non-collapsible navbox heading.
+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.
-;{{tl|Tnavbar-navframe}}: For use in conjunction with [[Wikipedia:NavFrame|Navframe div]]s, positions <small>v • d • e</small> opposite of the [hide]/[show] feature.
-;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]],floats <small>v • d • e</small> opposite of the [hide]/[show] feature.
-== See also ==
+==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}}
-{{Navigational templates}}
+{{Navigation templates}}
-<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
+== TemplateData ==
-<includeonly>
+{{TemplateData header}}
-[[Category:Internal link templates|{{PAGENAME}}]]
+<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
-[[af:Sjabloon:Tnavbar]]
+                },
-[[ang:Template:Tnavbar]]
+                "mini": {
-[[ar:قالب:Tnavbar]]
+                        "label": "Short Version",
-[[az:Şablon:Tnavbar]]
+                        "description": "Shortens text to V T E",
-[[ba:Ҡалып:Tnavbar]]
+                        "type": "number",
-[[be-x-old:Шаблён:Спасылкі шаблёну]]
+                        "default": "0",
-[[be:Шаблон:Tnavbar]]
+                        "required": false
-[[bg:Шаблон:Tnavbar]]
+                },
-[[bn:Template:তথ্যছক-Tnavbar]]
+                "brackets": {
-[[bpy:মডেল:Tnavbar]]
+                        "label": "with brackets",
-[[br:Patrom:Tnavbar]]
+                        "description": "adds brackets before and after the links",
-[[bs:Šablon:Tnavbar]]
+                        "type": "number",
-[[ca:Plantilla:Tnavbar]]
+                        "default": "0",
-[[ceb:Template:Tnavbar]]
+                        "required": false
-[[cs:Šablona:Tnavbar]]
+                },
-[[cv:Шаблон:Tnavbar]]
+                "fontstyle": {
-[[cy:Nodyn:Bar llywio]]
+                        "label": "Font color",
-[[da:Skabelon:Tnavbar]]
+                        "description": "Allows you to change the color of the font (in the format color:green)",
-[[dsb:Pśedłoga:Tnavbar]]
+                        "type": "string",
-[[dv:Template:Tnavbar]]
+                        "default": "",
-<!-- [[en:Template:Navbar]] -->
+                        "required": false
-[[et:Mall:Navbar]]
+                },
-[[el:Πρότυπο:Tnavbar]]
+                "style": {
-[[es:Plantilla:Tnavbar]]
+                        "label": "To float to the side",
-[[eo:Ŝablono:Tnavbar]]
+                        "description": "Allows the template to float to the side (format=float:right)",
-[[eu:Txantiloi:Tnavbar]]
+                        "type": "string",
-[[fa:الگو:Navbar]]
+                        "default": "float:left",
-[[fr:Modèle:Tnavbar]]
+                        "required": false
-[[fi:Malline:Tnavbar]]
-[[fo:Fyrimynd:Tnavbar]]
+                 }
-[[ga:Teimpléad:Tnavbar]]
+        }
-[[gl:Modelo:Tnavbar]]
+}
-[[gu:Template:Tnavbar]]
+</templatedata>
-[[haw:Template:Tnavbar]]
-[[hi:साँचा:Tnavbar]]
+<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
-[[hr:Predložak:Tnavbar]]
+<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
-[[hsb:Předłoha:Tnavbar]]
+[[Category:Internal link templates]]
-[[hu:Sablon:Tnavbar]]
+}}</includeonly>
-[[hy:Կաղապար:Tnavbar]]
-[[id:Templat:Tnavbar]]
-[[ilo:Template:Tnavbar]]
-[[os:Шаблон:Tnavbar]]
-[[it:Template:Tnavbar]]
-[[is:Snið:Tnavbar]]
-[[ja:Template:Tnavbar]]
-[[jv:Cithakan:Tnavbar]]
-[[ka:თარგი:Tnavbar]]
-[[kk:Үлгі:Tnavbar]]
-[[km:ទំព័រគំរូ:Tnavbar]]
-[[kn:ಟೆಂಪ್ಲೇಟು:Tnavbar]]
-[[ko:틀:안내 참조]]
-[[ku:Şablon:Tnavbar]]
-[[kw:Template:Tnavbar]]
-[[la:Formula:Tnavbar]]
-[[lmo:Template:Tnavbar]]
-[[lo:ແມ່ແບບ:Tnavbar]]
-[[lt:Šablonas:Tnavbar]]
-[[lv:Veidne:Tnavbar]]
-[[mi:Template:Tnavbar]]
-[[mk:Шаблон:Тнавлента]]
-[[ml:ഫലകം:Tnavbar]]
-[[mn:Template:Tnavbar]]
-[[ms:Templat:Tnavbar]]
-[[mt:Template:Tnavbar]]
-[[mr:साचा:Tnavbar]]
-[[nah:Plantilla:Tnavbar]]
-[[ne:Template:Tnavbar]]
-[[new:Template:Tnavbar]]
-[[nn:Mal:Tnavbar]]
-[[no:Mal:Tnavbar]]
-[[nov:Template:Tnavbar]]
-[[oc:Modèl:Tnavbar]]
-[[pag:Template:Tnavbar]]
-[[pam:Template:Tnavbar]]
-[[pih:Template:Tnavbar]]
-[[pl:Szablon:Tnavbar]]
-[[ps:کينډۍ:Tnavbar]]
-[[pt:Predefinição:Navbar]]
-[[qu:Plantilla:Tnavbar]]
-[[rm:Template:Tnavbar]]
-[[ro:Format:Tnavbar]]
-[[ru:Шаблон:Tnavbar]]
-[[sd:Template:Tnavbar]]
-[[sh:Template:Tnavbar]]
-[[si:සැකිල්ල:Tnavbar]]
-[[simple:Template:Tnavbar]]
-[[sk:Šablóna:Tnavbar]]
-[[sl:Predloga:Prednavmeni]]
-[[sr:Шаблон:Tnavbar]]
-[[su:Citakan:Tnavbar]]
-[[sq:Stampa:Tnavbar]]
-[[sv:Mall:Tnavbar]]
-[[sw:Template:Tnavbar]]
-[[ta:வார்ப்புரு:Tnavbar]]
-[[te:మూస:Tnavbar]]
-[[tg:Шаблон:Tnavbar]]
-[[th:แม่แบบ:Tnavbar]]
-[[tl:Template:Tnavbar]]
-[[tr:Şablon:Dçubuğu]]
-[[tw:Template:Tnavbar]]
-[[uk:Шаблон:Tnavbar]]
-[[ur:سانچہ:Tnavbar]]
-[[uz:Shablon:Tnavbar]]
-[[vec:Template:Tnavbar]]
-[[vi:Tiêu bản:Tnavbar]]
-[[wa:Modele:Tnavbar]]
-[[war:Template:Tnavbar]]
-[[wuu:Template:Tnavbar]]
-[[yi:מוסטער:Tnavbar]]
-[[yo:Template:Tnavbar]]
-[[zh:Template:Tnavbar]]
-[[zh-min-nan:Template:Tnavbar]]
-[[zh-yue:Template:Tnavbar]]
-</includeonly>