View source for Template:Abbr/doc

{{Documentation subpage}} __NOTOC__
<!-- PLEASE ADD CATEGORIES WHERE INDICATED AT THE END -->
{{High-risk|227,000+}}
{{COinS safe|n}}
{{hatnote|For inline cleanup templates requesting definitions or explanations, see {{tl|Definition}} and {{tl|Elucidate}}.}}

{{stack|{{template shortcuts|Abbrv|Define|Tooltip}}}}

The template&nbsp;{{tl|Abbr}} is used to write an abbreviation with its meaning. It is a wrapper for the [[HTML]] [[HTML element#General phrase elements|element]] {{tag|abbr}}, the element used by most [[WWW|web]] [[Web browser|browsers]] to create a [[tooltip]] indicating the meaning of an abbreviation or [[acronym]].

{{strong|Please note: Do not use {{tnull|abbr}} or {{tag|abbr|o}} to mark up material other than abbreviations or acronyms. Using it to generate tooltips elsewhere is a misuse of the underlying HTML and causes [[WP:ACCESS|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&nbsp;{{tl|abbr}} takes two unnamed parameters, in order:
* ''abbreviation'': The abbreviation; shows as text.
* ''meaning'': The meaning; shows as the tooltip.

A third unnamed parameter accepts the following values:
* '''IPA''' or '''i''': Applies {{tl|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
|<nowiki>{{abbr|MSLP|Mean Sea Level Pressure}}</nowiki>
|{{abbr|MSLP|Mean Sea Level Pressure}}
}}

When hovering over the text "{{abbr|MSLP|Mean Sea Level Pressure}}", something like {{titlehint|Mean Sea Level Pressure}} will appear as a tooltip in most browsers. Popular [[screen reader]]s, used by visually impaired readers, give the meaning in a different way.

{{markup
|<nowiki>{{abbr|UK|United Kingdom|class=country-name|id=foobar}}</nowiki>
|{{abbr|UK|United Kingdom|class=country-name|id=foobar}}
}}

== 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 {{tag|abbr|o}} element generated by this template; see section [http://www.w3.org/TR/WCAG20-TECHS/H28.html H28: Providing definitions for abbreviations by using the abbr and acronym elements].

== Redirects ==

The following template names will [[Wikipedia:Redirect|redirect]] to {{tl|abbr}}:
* {{tl|Abbrv}}
* {{tl|Define}}
* {{tl|Tooltip}}

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

== See also ==
* {{tl|abbrlink}}, a variant of this template that includes wikilinking.
* {{tl|H:title}}, used for generating tooltips in general.
* {{tl|R-phrase}}, which generates&nbsp;the abbreviation (the code number) for a [[List of R-phrases|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.
* {{tl|clarify}}, which produces the inline superscript:&nbsp; {{fake clarify}}.

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- CATEGORIES AFTER THIS LINE, PLEASE: -->
[[Category:Wikipedia XHTML tag-replacing templates]]
[[Category:Text-specific formatting and function templates]]
[[Category:Semantic markup templates]]

}}</includeonly>