Template:Navbar/doc: Difference between revisions

From Zoophilia Wiki
Jump to navigationJump to search
(partial self-rv per: http://tools.wmflabs.org/templatecount/index.php?lang=en&namespace=10&name=Navbar#bottom)
meta>Edokter
({{lua}})
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{high-risk|6,200,000+}}
{{high-risk|6,200,000+}}
{{lua|Module:Navbar}}
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->



Revision as of 07:41, 15 April 2015

Usage

General

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:

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

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

Optional parameters

Options Parameters Produces...
Basic {{navbar|Template Name}}
Different text {{navbar|Template Name|text=This template:}}
Without "This box:" text {{navbar|Template Name|plain=1}}
Short version {{navbar|Template Name|mini=1}}
With brackets {{navbar|Template Name|brackets=1}}
With a color option (span) {{navbar|Template Name|fontstyle=color:green}}
To float to the side (div) {{navbar|Template Name|style=float:right}}

Deprecated parameters

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

Notes

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 the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

Prepackaged

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

See also

[] Compare different edit templates:
  • {{Ed}} —– plain-style edit link surrounded by <small> tags, specifically for templates only
  • {{Ed right}} —– plain-style edit link surrounded by <small> tags and aligned to right of page, specifically for templates only
  • {{Edit}} —– plain-style edit link, applicable to all Wikipedia namespaces
  • {{Edit section}} —– edit link surrounded by <div> tags by default which can specify which section to edit on a page, applicable to all Wikipedia namespaces
  • {{Edit sup}} —– plain-style edit link surrounded by <sup> tags, applicable to all Wikipedia namespaces
  • {{Edit sub}} —– plain-style edit link surrounded by <sub> tags, applicable to all Wikipedia namespaces
  • {{Vedit}} —– plain-style edit link which edit with the Wikipedia:VisualEditor, applicable to all Wikipedia namespaces

Templates with view, talk and edit links:

  • {{Navbar}} —– navigation bar with configurable caption and view·talk·edit links, specifically for templates only
  • {{View}} —– navbar-style view·talk·edit links, specifically for templates only
  • {{VTE}} & {{V}} —– navbar-style V·T·E links (i.e. view·talk·edit links in short forms), specifically for templates only
Navigation templates comparison
Collapsible Header color Image Groups Style (body)
parameter/s
Examples
{{Navbox}} collapsible navbox Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible navbox Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible navbox Left/right of columns No Yes
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


Parameter names cannot be empty. To document unnamed parameters use their internal numbers "1", "2", and so on.