Template:Abbr

From Wikipedia, the free encyclopedia
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

{{Abbr}} is a front-end for the HTML element <abbr>...</abbr> used by most web browsers to create a tooltip giving the meaning of an abbreviation (including an acronym).

Do not use {{abbr}} or <abbr> to mark up material other than abbreviations. Using it to generate tooltips in other case is an abuse of the underlying HTML and an accessibility problem.

Usage

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

  • short form: shows as text
  • long form: shows as the tooltip

Named parameters:

  • IPA or i: Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP.
  • unicode or u: Applies {{unicode}} to fix strings in Unicode rendered in Internet Explorer on Windows XP.
  • class: Adds a CSS class.
  • id: Adds an HTML id; this must be unique on the entire page


Examples

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

When hovering over the text "MSLP" then something like Mean Sea Level Pressure will appear as a tooltip in most browsers. Popular screen readers, used by visually impaired readers, display the long form 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> element generated by this template; see section H28: Providing definitions for abbreviations by using the abbr and acronym elements.

Redirects

The following template names redirect to this one:

Template data

This is the TemplateData documentation for this template used by VisualEditor and other tools.

Abbr

This template defines an abbreviation or acronym by creating a tooltip that is displayed on mouse-over.

Template parameters
Parameter Description Type Default Status
Short form 1 Shows as text line empty required
Long form 2 Shows as a tooltip string empty required
IPA IPA Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP line empty optional
Unicode unicode Applies {{unicode}} to fix strings in Unicode rendered in Internet Explorer on Windows XP line empty optional
Class class Adds an HTML class line empty optional
ID id Adds an HTML id line empty optional

See also