Template:Abbr/doc

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

{{Abbr}} 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.

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.

Usage

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

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

A third unnamed parameter accepts the following values:

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

Named parameters:

class: Adds a CSS class.
id: Adds an 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" 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:

{{Define}}
{{Explain}}
{{Tooltip}}

Template data

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

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
Short form	`1`	Shows as text	Line	required
Long form	`2`	Shows as a tooltip	String	required
IPA/Unicode	`3`	If it is filled with 'IPA' or 'i', applies {{IPA}} to fix strings in the International Phonetic Alphabet; if it is filled instead with 'Unicode' or 'u', applies {{unicode}} to fix strings in Unicode, both rendered in Internet Explorer on Windows XP	Line	optional
Class	`class`	Adds an HTML class	Line	optional
ID	`id`	Adds an HTML id	Line	optional
style	`style`	Add CSS style	String	optional