Template:Navbar/doc

From HIVE
< Template:Navbar
Revision as of 18:04, 8 January 2011 by DevliN (talk | contribs) (1 revision: Templates)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
40px 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.
40x40px This template is used on 6,000,000+ pages.
To avoid large-scale disruption and unnecessary server load, any changes should first be tested in this template's /sandbox or /testcases subpage, or in your own user space. The tested changes can then be added in one single edit to this template. Please consider discussing any changes on the talk page before implementing them.

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: This box: view · talk · edit

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} This box: view · talk · edit

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} view · talk · edit

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} v · d · e

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} This box: view · talk · edit

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} This box: [view · talk · edit]

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar

Deprecated parameters

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

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

With additional links:

Navigation templates comparison
view · talk · edit

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}}|fontstyle=color:green}}

The {{subst:PAGENAME}} will be substituted with the template's name when parsed by the servers. {{navbar|navbar/doc}} gives: Template loop detected: Template:Navbar

Examples

Required parameters

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

Optional parameters

Options Parameters Produces...
Normal {{navbar|Template Name}} Template loop detected: Template:Navbar
No "This box:" text. {{navbar|Template Name|plain=1}} Template loop detected: Template:Navbar
Short version. {{navbar|Template Name|mini=1}} Template loop detected: Template:Navbar
For a color option. {{navbar|Template Name|fontstyle=color:green}} Template loop detected: Template:Navbar
With brackets. {{navbar|Template Name|brackets=1}} Template loop detected: Template:Navbar
Collapsible Header color Image Groups Style (body)
parameter/s		 Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes {{United States Congress}} · {{Solar System}}
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes {{Current U.S. Senators}} · {{Czech lands}}
{{Navbox years}} 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


Retrieved from "https://wiki.hiveworkshop.com/index.php?title=Template:Navbar/doc&oldid=1233"