Difference between revisions of "Template:Navbar/doc"

From Recidemia English
Jump to: navigation, search
m (1 revision)
m (Increase template usage)
Line 1: Line 1:
 
{{documentation subpage}}
 
{{documentation subpage}}
−
{{high-risk|6,000+}}
+
{{high-risk|7,200,000+}}
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
  
 
== Usage ==
 
== Usage ==
 
===General===
 
===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>  
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1}}</nowiki></tt>  
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1}}</nowiki></tt>  
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}</nowiki></tt>
 
−
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}</nowiki></tt>
 
 
:<tt><nowiki>{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}</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.
+
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}}
+
 
 +
===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 ==
 
== Examples ==
 
===Required parameters===
 
===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===
 
===Optional parameters===
Line 23: Line 24:
 
! Options !! Parameters !! Produces...
 
! 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|text=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|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
 
|-
 
|-
−
| Good for "blending" into text. || <code><nowiki>{{navbar|Template Name|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|nodiv=1}} Ipsum
+
| Short version || <code><nowiki>{{navbar|Template Name|mini=1}}</nowiki></code> || {{navbar|navbar/doc|mini=1}}
 
|-
 
|-
−
|Blended, no "This box:" text. || <code><nowiki>{{navbar|Template Name|plain=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|plain=1|nodiv=1}} Ipsum
+
| With brackets
 +
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
 +
| {{navbar|navbar/doc|brackets=1}}
 
|-
 
|-
−
|Blended, short version. || <code><nowiki>{{navbar|Template Name|mini=1|nodiv=1}}</nowiki></code> || Lorem {{navbar|navbar/doc|mini=1|nodiv=1}} Ipsum
+
| With a color option ([[Span and div|span]]) || <code><nowiki>{{navbar|Template Name|fontstyle=color:green}}</nowiki></code> || {{navbar|navbar/doc|fontstyle=color:green}}
 
|-
 
|-
−
| For a color option. || <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}}
−
|-
 
−
| With brackets.
 
−
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
 
−
| {{navbar|navbar/doc|brackets=1}}
 
 
|}
 
|}
  
−
===Prepackaged===
+
===Deprecated parameters===
−
;{{tl|Tnavbar-header}}: Positions <small>v • d • e</small> on the right edge of the line.
+
The <tt>miniv=1</tt>, <tt>viewplain=1</tt>, <tt>nodiv=1</tt> and <tt>fontcolor=</tt> 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 Tidy will 'fix' situations where it finds block elements inside inline elements.
 +
 
 +
== Prepackaged ==
 +
;{{tl|Tnavbar-header}}: Positions {{navbar|navbar/doc|mini=1}} 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-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}}
  
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<includeonly>
 
<includeonly>
−
[[Category:Internal link templates|{{PAGENAME}}]]
+
[[Category:Internal link templates]]
 +
 
 +
[[af:Sjabloon:Tnavbar]]
 +
[[ang:Template:Tnavbar]]
 +
[[ar:قالب:Tnavbar]]
 +
[[az:Şablon:Tnavbar]]
 +
[[ba:Ҡалып:Tnavbar]]
 +
[[be-x-old:Шаблён:Спасылкі шаблёну]]
 +
[[be:Шаблон:Tnavbar]]
 +
[[bg:Шаблон:Tnavbar]]
 +
[[bn:Template:তথ্যছক-Tnavbar]]
 +
[[bpy:মডেল:Tnavbar]]
 +
[[br:Patrom:Tnavbar]]
 +
[[bs:Šablon:Tnavbar]]
 +
[[ca:Plantilla:Tnavbar]]
 +
[[ceb:Template:Tnavbar]]
 +
[[cs:Šablona:Tnavbar]]
 +
[[cv:Шаблон:Tnavbar]]
 +
[[cy:Nodyn:Bar llywio]]
 +
[[da:Skabelon:Tnavbar]]
 +
[[dsb:Pśedłoga:Tnavbar]]
 +
[[dv:Template:Tnavbar]]
 +
[[et:Mall:Navbar]]
 +
[[el:Πρότυπο:Tnavbar]]
 +
[[es:Plantilla:Tnavbar]]
 +
[[eo:Ŝablono:Tnavbar]]
 +
[[eu:Txantiloi:Tnavbar]]
 +
[[fa:الگو:Navbar]]
 +
[[fr:Modèle:Tnavbar]]
 +
[[fi:Malline:Tnavbar]]
 +
[[fo:Fyrimynd:Tnavbar]]
 +
[[ga:Teimpléad:Tnavbar]]
 +
[[gl:Modelo:Tnavbar]]
 +
[[gu:Template:Tnavbar]]
 +
[[haw:Template:Tnavbar]]
 +
[[hi:साँचा:Tnavbar]]
 +
[[hr:Predložak:Tnavbar]]
 +
[[hsb:Předłoha:Tnavbar]]
 +
[[hu:Sablon:Tnavbar]]
 +
[[hy:Կաղապար:Tnavbar]]
 +
[[id:Templat:Tnavbar]]
 +
[[ilo:Template:Tnavbar]]
 +
[[os:Шаблон:Tnavbar]]
 +
[[it:Template:Tnavbar]]
 +
[[is:Snið:Tnavbar]]
 +
[[ja:Template:Tnavbar]]
 +
[[jv:Cithakan:Tnavbar]]
 +
[[ka:თარგი:Tnavbar]]
 +
[[csb:Szablóna:Navbar]]
 +
[[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:navbar]]
 +
[[zh-min-nan:Template:Tnavbar]]
 +
[[zh-yue:Template:Tnavbar]]
 
</includeonly>
 
</includeonly>

Revision as of 21:25, 29 April 2012

Edit-copy green.svg This is a documentation subpage for Template:Navbar.
It contains usage information, categories, interlanguage links and other content that is not part of the original template page.
This template is used on 7,200,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in the template's /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added in one single edit to the template. Please consider discussing any changes on the talk page before implementing them.

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:

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:
Different text {{navbar|Template Name|text=This template:}}
This template:
Without "This box:" text {{navbar|Template Name|plain=1}}
Short version {{navbar|Template Name|mini=1}}
With brackets {{navbar|Template Name|brackets=1}}
This box: [ ]
With a color option (span) {{navbar|Template Name|fontstyle=color:green}}
This box:
To float to the side (div) {{navbar|Template Name|style=float:right}}
This box:

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
on the right edge of the line, often used in non-collapsible navbox heading.
{{Tnavbar-navframe}}
For use in conjunction with Navframe divs, positions
opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}
For use in conjunction with Collapsible tables, floats
opposite of the [hide]/[show] feature.

See also

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

With additional links:

Navigation templates comparison
Collapsible Header color Image Groups Style (body)
parameter/s		 Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes
{{Navbox years}} collapsible navbox No No No
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


Retrieved from "http://en.recidemia.com/index.php?title=Template:Navbar/doc&oldid=196631"