Wiktenauer logo.png

Template:Abbr/doc

From Wiktenauer
< Template:Abbr
Revision as of 18:34, 8 January 2016 by Michael Chidester (talk | contribs) (Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE END --> {{stack|{{template shortcut|Abbrv|Define|Tooltip}}}} The template {{tl|Abbr}} is used...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

The template {{Abbr}} is used to write an abbreviation with its meaning. It is a front-end for the HTML element <abbr></abbr>, the element used by most web browsers to create a tooltip indicating the meaning of an abbreviation or acronym.

Usage

The template {{abbr}} takes two unnamed parameters, in order:

  • abbreviation: The abbreviation; shows as text.
  • meaning: The meaning; shows as the tooltip.

A third unnamed parameter accepts the following values:

Named parameters:

  • class: Adds a CSS class.
  • id: Adds a HTML id; this must be unique on the entire page.
  • style: Adds a style attribute.

Examples

Markup Renders as
{{abbr|MSLP|Mean Sea Level Pressure}}
MSLP

When hovering over the text "MSLP", something like Mean Sea Level Pressure will appear as a tooltip in most browsers. Popular screen readers, used by visually impaired readers, give the meaning in a different way.

Markup Renders as
{{abbr|UK|United Kingdom|class=country-name|id=foobar}}
UK

Accessibility concerns

This template is intended for use with abbreviations; it is not intended to be a tool for generating tooltips. The Web Content Accessibility Guidelines contain guidelines for using the <abbr></abbr> element generated by this template; see section H28: Providing definitions for abbreviations by using the abbr and acronym elements.

Redirects

The following template names will redirect to {{abbr}}:

See also

  • {{abbrlink}}, a variant of this template that includes wikilinking.
  • {{H:title}}, used for generating tooltips in general.
  • {{R-phrase}}, which generates the abbreviation (the code number) for a R-phrase (a "risk phrase", e.g. "Explosive when dry"). The R-phrase itself and a link to List of R-phrases are included in a tooltip.
  • {{clarify}}, which produces the inline superscript:  Template:Fake clarify.