Template:Abbr/doc

From MusicNation
Jump to navigation Jump to search

{{abbr}} is used to define an abbreviation or acronym by creating a tooltip that is displayed on mouse-over. The template uses the HTML <abbr> element and is supported by most browsers.

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 an HTML class
  • id: adds an HTML id

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|pȅći • пе̏ћи|to say}}

pȅći • пе̏ћи

{{abbr|pȅći • пе̏ћи|to say|unicode}}

pȅći • пе̏ћи

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 redirect to this one:

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

ParameterDescriptionTypeStatus
Short form1

Shows as text

Linerequired
Long form2

Shows as a tooltip

Stringrequired
IPAIPA

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

Lineoptional
Unicodeunicode

Applies {{unicode}} to fix strings in Unicode rendered in Internet Explorer on Windows XP

Lineoptional
Classclass

Adds an HTML class

Lineoptional
IDid

Adds an HTML id

Lineoptional

See also