Template:Abbr/doc
 | This is a documentation subpage for Template:Abbr. It may contain usage information, categories and other content that is not part of the original template page. |
 | The former Template:Tooltip redirects here. However, this template should not be used for general tooltips, and the redirect is deprecated per this RfD. |
 | This template is used on 452316 pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user space. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
The template {{Abbr}} is used to write an abbreviation with its meaning. It is a wrapper 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. See {{Hover title}} for how to implement similar functionality without abusing markup (though it is also not accessibility-perfect as of June 2018[update] input sought at Template talk:Hover title).
Usage
The template {{abbr}} takes two unnamed parameters, in order:
1- Template:Kbd – 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- Template:Kbd – 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 (Template:Kbd) character:
- Complex example:
[[Mass–energy equivalence|{{abbr|{{math|''E'' {{=}} ''mc''<sup>2</sup>}}|2=Energy = mass times the speed of light squared}}]] - Produces: E = mc2
A third unnamed parameter accepts the following values (which have the same effect):
3- Template:Kbd or Template:Kbd – 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.
|style=font-family: 'Times New Roman', serif;
Examples
| Markup =scope="col" style="width:50%;"| Renders as | |
|---|---|
{{abbr|MSLP|Mean Sea Level Pressure}}
|
MSLP |
When hovering over the text "MSLP", something like Mean Sea Level Pressure will appear as a tooltip in most browsers. Popular screen readers, used by visually impaired readers, give the meaning in a different way.
| Markup =scope="col" style="width:50%;"| Renders as | |
|---|---|
{{abbr|UK|United Kingdom|class=country-name|id=foobar}}
|
UK |
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 <abbr> 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).
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.
Furthermore, the HTML specifications (both those of the W3C and WHATWG) strictly define the <abbr> 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.).
Redirects
The following template names will redirect to {{abbr}}:
Template data
See also
- {{abbrlink}}, a variant of this template that includes wikilinking.
- {{H:title}}, used for generating tooltips in general.
- {{R-phrase}}, which generates the abbreviation (the code number) for an 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.
- {{clarify}}, which produces the inline superscript: Template:Fake clarify.
- {{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.
