Template:Navbar/doc: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
Line 53: Line 53:
[[Category:Formatting templates]]
[[Category:Formatting templates]]
</includeonly>
</includeonly>
<noinclude>
[[Category:Tnavbar]]
</noinclude>

Revision as of 16:08, 9 June 2014

This is a documentation subpage for Template:Navbar (see that page for the template itself).
It contains usage information, categories and other content that is not part of the original template page.

Usage

General

When one of the following examples is placed inside a given Help:templates, 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 a color option {{navbar|Template Name|fontstyle=color:green}}
With brackets {{navbar|Template Name|brackets=1}}

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

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.