Jump to content

Template:Navbar/doc

From Calamity Wiki
Revision as of 15:25, 25 January 2020 by Vertex (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Usage

General

When one of the following examples is placed inside a given template, it adds navbar navigational functionality:

{{navbar|{{subst:PAGENAME}}|mini=y}}
{{navbar|{{subst:PAGENAME}}|plain=y}}
{{navbar|{{subst:PAGENAME}}|fontstyle=color: green; font-style: italic;}}

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. The |fontstyle= parameter can be used to adjust font size as needed (e.g. to reduce font size even more when the template is used inside a block element with a large font size).

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=y}}
Short version {{navbar|Template Name|mini=y}}
With brackets {{navbar|Template Name|brackets=y}}
With font styling examples (span) {{navbar|Template Name|fontstyle=color: green; font-style: italic;}}
With whole-template styling examples (div) {{navbar|Template Name|style=float:right; background: Beige; padding: 5px; border: 1px solid;}}

Deprecated parameters

The miniv=y, viewplain=y, nodiv=y 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

  • {{Ed}} – navbar style edit link
  • {{Ed right}} – navbar style edit link aligned to right of page
  • {{Edit}} – plain edit link
  • {{Edit section}} – edit link aligned to right of page
  • {{Navbar}} – with additional links
  • {{Vedit}} – edit with the Visual Editor
Navigation templates comparison
Template Collapsible Image Groups Style (body)
parameter/s
{{Navbox}} collapsible Left/right of body Yes Yes
{{Navbox with collapsible groups}} collapsible Left/right of body and/or in each list Yes Yes
{{Navbox with columns}} collapsible Left/right of columns No Yes
Collapsible attributes
Type CSS classes JavaScript Collapses when Custom
initial state
Nesting
Collapsible tables mw-collapsible jQuery.makeCollapsible 2 or more autocollapse on page Yes Yes

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Navbar in articles based on its TemplateData.

TemplateData for Navbar

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