Template:Abbr
The template is used to write an abbreviation with its meaning. It is a wrapper for the HTML element abbr, the element used by most browsers to create a tooltip indicating the meaning of an abbreviation or acronym.
Please note: Do not use or 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 {{{2}}} for how to implement similar functionality without abusing markup.
Usage
The template takes two unnamed parameters, in order:
- 1
- abbreviation – the abbreviation, acronym, or initialism to be explained; shows as text, and may use wikimarkup, such as a link to an article about what it refers to.
- 2
- meaning – the expansion or definition of the abbreviation; shows as the popup when you hover over the abbreviation. No wikimarkup can be used in this parameter.
These can also be given as explicitly numbered parameters; this is necessary if a parameter's content contains the equals (=) character:
- Complex example:
[[Mass–energy equivalence|{{abbr|{{math|''E'' {{=}} ''mc''<sup>2</sup>}}|2=Energy = mass times the speed of light squared}}]] - Produces: [[Mass–energy equivalence|Template:Math]]
A third unnamed parameter accepts the following values (which have the same effect):
- 3
- IPA or i – applies the IPA template to fix the International Phonetic Alphabet rendering on Windows XP.
Named parameters and the input they take:
class- One or more CSS classes (space-separated if more than one)
id- An HTML id (i.e., a
#ID name herelink anchor); this must be unique on the entire page style- Arbitrary inline CSS to apply to the Template:Kbd text. For any input that needs to be quotation-marked (e.g. because it contains a space character), use straight single-quotes only, e.g. font-family: 'Times New Roman', serif;
Examples
When hovering over the text "MSLP", something like Template:Titlehint will appear as a tooltip in most browsers. Popular screen readers, used by visually impaired readers, give the meaning in a different way.
Linking must be done a particular way
To wiki-link the abbreviation being marked up by this template, wrap the template in the link, not vice-versa, or the meaning will not appear in some browsers, including Chrome.
| Compatibility | Markup | Renders as |
|---|---|---|
| Compatible | [[Knockout#Technical knockout|{{abbr|TKO|technical knockout}}]] | TKO |
| Less compatible | {{abbr|[[Knockout#Technical knockout|TKO]]|technical knockout}} | TKO |
Do not link, or use any other wikimarkup or HTML markup, in the meaning (popup) – only plain text.
The mouse-over popup for the meaning text is created by a title= attribute inside an HTML element's opening tag, so it cannot itself contain any HTML (or markup that resolves to HTML when rendered). This includes simple things like ''italics''.
Accessibility and HTML validity concerns
This template is intended only for use with abbreviations (including acronyms and initialisms).
Furthermore, the HTML specifications (both those of the W3C and WHATWG) strictly define the { element as reserved for markup of abbreviations. Abusing it for mouse-over tooltips breaks our semantic markup and makes our content invalid HTML (technically, "not well-formed"; it will pass an basic automated validator test because such a tool can't tell that the logical application of the data to the structure isn't correct, only that tags are nested properly, etc.).
Template data
This template defines an abbreviation or acronym, by creating a tooltip that is displayed on mouse-over.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Abbreviation | 1 | Shows as text | Line | required |
| Meaning | 2 | Shows as a tooltip | String | required |
| IPA | IPA | Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP | Line | optional |
| Class | class | Adds a HTML class | Line | optional |
| ID | id | Adds a HTML id | Line | optional |
See also
- Template:Abbrlink, a variant of this template that includes wikilinking.
- Template:H:title, used for generating tooltips in general.
- Template:Finedetail, which allows a main fact to be presented in an article while hiding finer detail which, although factually accurate and maybe of interest to specific readers, might detract from the general readability of the article by cluttering the article if always presented; it allows referencing.
