Template:Navbar/doc

From YUIkipedia
Jump to navigation Jump to search

Usage

General

Copyable examples when inside a given template adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=1}}
{{navbar|{{subst:PAGENAME}}|plain=1}}
{{navbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}
{{navbar|{{subst:PAGENAME}}|fontstyle=color:green}}
The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers.
{{navbar|navbar/doc}} gives:

Deprecated parameters

The miniv=1, viewplain=1 and fontcolor= parameters have been deprecated. To use the view-only version, use the {{v}} or {{view}} templates instead.

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}}
No "This box:" text. {{navbar|Template Name|plain=1}}
Short version. {{navbar|Template Name|mini=1}}
Good for "blending" into text. {{navbar|Template Name|nodiv=1}} Lorem  This box: view  talk  edit  Ipsum
Blended, no "This box:" text. {{navbar|Template Name|plain=1|nodiv=1}} Lorem  view  talk  edit  Ipsum
Blended, short version. {{navbar|Template Name|mini=1|nodiv=1}} Lorem  v  d  e  Ipsum
For a color option. {{navbar|Template Name|fontstyle=color:green}}
With brackets. {{navbar|Template Name|brackets=1}}

Prepackaged

{{Tnavbar-header}}
Positions v • d • e on the right edge of the line, often used in non-collapsible navbox heading.
{{Tnavbar-navframe}}
For use in conjunction with Navframe divs, positions v • d • e opposite of the [hide]/[show] feature.
{{Tnavbar-collapsible}}
For use in conjunction with Collapsible tables,floats v • d • e opposite of the [hide]/[show] feature.

See also

Navigation templates comparison
collapsible Header color Image Groups Style (body)
parameter/s
Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes {{USCongress}} · {{Solar System}}
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes {{Current U.S. Senators}} · {{Czech lands}}
{{NavboxYears}} collapsible navbox No No No {{Wimbledon tournaments}}
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes {{University of Michigan}} · {{Scouting}}
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