Difference between revisions of "Module:Navbar/doc"

From blackwiki
Jump to navigation Jump to search
test>Alejandroadan
m (Corrected usage)
test>Mr. Stradivarius
(create documentation stub)
Line 1: Line 1:
{{documentation subpage}}
+
{{module rating|protected}}
{{high-risk|7,055,000+}}
+
{{bad documentation}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
  
== Usage ==
+
This is a [[WP:Lua|Lua]] implementation of {{tl|navbar}}. It is used in [[Module:Navbox]].
===General===
 
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}}|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:<br> {{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 brackets
 
| <code><nowiki>{{navbar|Template Name|brackets=1}}</nowiki></code>
 
| {{navbar|navbar/doc|brackets=1}}
 
|-
 
| With a color option ([[Span and div|span]]) || <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}}
 
|}
 
 
 
===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|Navbar-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|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}}
 
 
 
<!--- PLEASE ADD METADATA TO THE <includeonly> SECTION HERE --->
 
<includeonly>
 
[[Category:Internal link templates]]
 
</includeonly>
 

Revision as of 11:05, 8 June 2013

This is a Lua implementation of {{navbar}}. It is used in Module:Navbox.