Template:Abbr/doc

{{#invoke:Message box|mbox}} {{#invoke:Message box|mbox}} {{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:

• {{Define}}
• {{Explain}}

Template data

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

Abbr

<TemplateData> {

       "description": "This template defines an abbreviation or acronym by creating a tooltip that is displayed on mouse-over.",
       "params": {
               "1": {
                       "label": "Short form",
                       "description": "Shows as text",
                       "type": "string/line",
                       "required": true
               },
               "2": {
                       "label": "Long form",
                       "description": "Shows as a tooltip",
                       "type": "string",
                       "required": true
               },
               "IPA": {
                       "label": "IPA",
                       "description": "Applies Template:IPA to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP",
                       "type": "string/line",
                       "required": false
               },
               "unicode": {
                       "label": "Unicode",
                       "description": "Applies {{{1}}} to fix strings in Unicode rendered in Internet Explorer on Windows XP",
                       "type": "string/line",
                       "required": false
               },
               "class": {
                       "label": "Class",
                       "description": "Adds an HTML class",
                       "type": "string/line",
                       "required": false
               },
               "id": {
                       "label": "ID",
                       "description": "Adds an HTML id",
                       "type": "string/line",
                       "required": false
               }
       }

} </TemplateData>

See also

• {{Abbrlink}} – Applies a wikilink to the content
• {{Discreet abbreviation}} – Prevents the abbreviation from having a dotted underline
• {{R-phrase}} – Generates the abbreviation for an EU R-phrase with a tooltip of the full text and a link to the description in List of R-phrases
• {{Clarify}}