Permanently protected template

Template:Abbr

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

The template {{Abbr}} is used to write an abbreviation with its meaning. It is a wrapper 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.

Please note: Do not use {{abbr}} or <abbr> to mark up material other than abbreviations or acronyms. Using it to generate tooltips elsewhere is a misuse of the underlying HTML and causes accessibility problems. See the code of Template:Glossary link internal for an example of how to implement similar functionality without abusing markup.

Usage

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

  1. abbreviation, the abbreviation; shows as text.
  2. meaning, the meaning; shows as the tooltip.

A third unnamed parameter accepts the following values:

  1. IPA or i: Applies {{IPA}} to fix the International Phonetic Alphabet rendering on Windows XP.

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> 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}}:

Template data

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

See the monthly error report for this template.

TemplateData for Abbr

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

Template parameters

Parameter Description Type Status
Abbreviation 1

Shows as text

Default
empty
Example
empty
Auto value
empty
Line required
Meaning 2

Shows as a tooltip

Default
empty
Example
empty
Auto value
empty
String required
IPA IPA

Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP

Default
empty
Example
empty
Auto value
empty
Line optional
Class class

Adds a HTML class

Default
empty
Example
empty
Auto value
empty
Line optional
ID id

Adds a HTML id

Default
empty
Example
empty
Auto value
empty
Line optional

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: [clarification needed].