Difference between revisions of "Template:Navbar/doc"

From Krafties
Jump to navigation Jump to search
(Created page with "{{documentation subpage}} <!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE---> == Usage == ===General=== When one of the following examples is...")
 
 
(One intermediate revision by the same user not shown)
Line 40: Line 40:
 
===Deprecated parameters===
 
===Deprecated parameters===
 
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.
 
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.
 +
| style=
  
 
== Notes ==
 
== 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.
 
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 <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 divs]], 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.
 
  
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->

Latest revision as of 05:24, 11 May 2017

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[edit]

General[edit]

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[edit]

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[edit]

Required parameters[edit]

  • {{navbar|Template Name}} – the template name is required.

Optional parameters[edit]

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[edit]

The miniv=1, viewplain=1, nodiv=1 and fontcolor= parameters have been deprecated. To implement the view-only version, use the Template:Tlx or Template:Tlx templates instead.

| style=

Notes[edit]

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.