Template:Navbar/doc - Revision history

MyraMidnight: /* Deprecated parameters */

2017-05-11T11:24:33Z

Deprecated parameters

MyraMidnight: /* Prepackaged */

2017-05-03T21:16:09Z

Prepackaged

MyraMidnight: Created page with "{{documentation subpage}} == Usage == ===General=== When one of the following examples is..."

2017-05-03T18:56:14Z

Created page with "{{documentation subpage}}  == Usage == ===General=== When one of the following examples is..."

New page

{{documentation subpage}}


== Usage ==
===General===
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: {{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 ==
===Required parameters===
*<code><nowiki>{{navbar|Template Name}}</nowiki></code> – the template name is required.

===Optional parameters===
{| class="wikitable"
! Options !! Parameters !! Produces...
|-
| Basic || <code><nowiki>{{navbar|Template Name}}</nowiki></code> || {{navbar|navbar/doc}}
|-
| Different text || <code><nowiki>{{navbar|Template Name|text=This template:}}</nowiki></code> || {{navbar|navbar/doc|text=This template:}}
|-
| Without "This box:" text || <code><nowiki>{{navbar|Template Name|plain=1}}</nowiki></code> || {{navbar|navbar/doc|plain=1}}
|-
| 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}}
|}

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

== 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 v{{·}}d{{·}}e 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 v{{·}}d{{·}}e opposite of the [hide]/[show] feature.
;{{tl|Tnavbar-collapsible}}: For use in conjunction with [[Wikipedia: NavFrame#Collapsible tables|Collapsible tables]], floats v{{·}}d{{·}}e opposite of the [hide]/[show] feature.


<includeonly>
[[Category:Formatting templates]]
</includeonly>

@@ Line 40: / Line 40: @@
 ===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.
 == Notes ==

@@ Line 43: / Line 43: @@
 == 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.
 <!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->