Template:Navbar/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
(Created page with "{{documentation subpage}} {{#ifeq:{{BASEPAGENAME}}|Navbar}} {{tl|Navbar}} provides a small "view '''·''' talk '''·''' edit" navigation bar....")
 
mNo edit summary
Line 1: Line 1:
{{documentation subpage}}
{{documentation subpage}}
{{template rating|p}}
{{#ifeq:{{BASEPAGENAME}}|Navbar}}
{{#ifeq:{{BASEPAGENAME}}|Navbar}}


Line 104: Line 105:
         }
         }
}
}
</templatedata><!---
</templatedata>
  PLEASE ADD METADATA TO THE <includeonly> SECTION HERE
 
---><includeonly></includeonly>
<includeonly>
<!-- Categories below this line, please -->
[[Category:Templates]]
</includeonly>

Revision as of 03:16, 6 September 2020

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.

Template:Template rating


{{Navbar}} provides a small "view · talk · edit" navigation bar. It is primarily used for content-heavy templates and other transcluded content blocks, so that the content inside the template or block is more easily editable in situations where it was found, without having track it down through examining transclusion code.

Usage

General

When one of the following examples is placed inside a given template (or block of content used for selective transclusion), it adds basic 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 page name of the real location of the content when parsed by the servers. For example, {{navbar|Navbar/doc}} gives:

When used in content that is selectively transcluded but which is also used as-is in its original location, this template should be wrapped in |includeonly|p markup, so that it only appears when transcluded.

Font size and weight

Font-size is 88% when used in a topical navbar template or in plain text, and 100% when nested in a navbox or infobox (because those templates' text size is already reduced; the "100%" is relative to the surrounding template's own content, not that of the entire page). 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). Do not abuse this to make excessively small text (i.e. less than 85% of the normal page text), since that causes accessibility problems for many readers.

In a topical navbar, the weight is "normal"; when nested in a navbox or infobox, it inherits the style of the surrounding content. The middot bullets are bold for better visibility.

Examples

Required parameters

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

Optional parameters

Options Parameters Produces... "Shortcut" template
Basic {{navbar|Template Name}}
Different text {{navbar|Template Name|text=This template:}}
Without "This box:" text {{navbar|Template Name|plain=y}} {{view}}
Short version {{navbar|Template Name|mini=y}} {{v}}
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;}}

Notes

Navbar is contained within a div tag in order to accommodate a horizontal unnumbered list. This means it cannot be placed inside a span tag or other inline element, because the HTML Tidy extension will 'fix' situations where it finds block elements inside inline elements.

TemplateData

When placed inside a given template, it adds navbar navigational functionality

Template parameters

ParameterDescriptionTypeStatus
Template Name

The name of the template, so links work correctly

Default
Stringrequired
Different texttext

Allows custom text to replace the default 'this box'

Default
This box
Stringoptional
Without 'This box:' textplain

Removes 'This box'

Default
0
Numberoptional
Short Versionmini

Shortens text to V T E

Default
0
Numberoptional
with bracketsbrackets

adds brackets before and after the links

Default
0
Numberoptional
Font colorfontstyle

Allows you to change the color of the font (in the format color:green)

Default
Stringoptional
To float to the sidestyle

Allows the template to float to the side (format=float:right)

Default
float:left
Stringoptional