Template:Abbr

Template documentation[view] [edit] [history] [purge]

For inline cleanup templates requesting definitions or explanations, see {{Definition}} and {{Explain}}.

Wikipedia uses two separate templates to generate tooltips. The {{abbr}} template is used to write an abbreviation (including an acronym or initialism) with its expanded meaning. It is a wrapper for the HTML element <abbr>...</abbr>. The {{tooltip}} template uses the <span>...</span> element to provide generic notes.

Only use {{abbr}} or <abbr> to mark up abbreviations (including acronyms and initialisms). Using it to generate tooltips elsewhere is a misuse of the underlying HTML and causes accessibility problems. For general-purpose tooltips, use {{tooltip}} instead.

Readers on mobile devices typically do not have a mouse to hover with, and so generally cannot see tooltip contents. As of 2023, more English Wikipedia page views occur on mobile than on desktop browsers.[1]

Usage

{{Abbr|text to display inline in the article|pop-up tip}}

Parameters

Two unnamed (positional) parameters (required) and three named parameters (optional):

• |1= – the term to be explained; displays as text. Wiki markup is allowed but works more consistently when wrapping the template, see below for linking examples.
• |2= – the tooltip/pop-up (no wiki or HTML markup allowed). The popup is created by an HTML title= attribute, so it cannot contain HTML (or markup that resolves to HTML when rendered). This includes simple things like ''italics''.
• |class= – one or more CSS classes (space-separated if more than one)
• |id= – an HTML ID must be unique on the entire page.
• |style= – CSS to apply to the displayed text (no effect on tooltip/popup). Any style values with embedded blanks must be single-quoted, e.g. |style=font-family: 'Times New Roman', serif;

Examples

Markup	Renders as
{{abbr|LSD|Louisiana School for the Deaf}}	LSD

When hovering over the text "LSD", something like Louisiana School for the Deaf will appear as a tooltip in desktop browsers. Mobile devices may display a dotted line or other visual indicator of abbreviation, but will not provide the tooltip. No screen readers for the visually impaired will read the expansion by default; some provide an optional setting to read the expansion aloud.

Abbr examples

Accessible when used in addition to inline expansion

Markup	Renders as
High school students staying overnight on the Louisiana School for the Deaf (LSD) campus can phone their parents using an American Sign Language (ASL) interpreter. Although fluent in {{abbr|ASL|American Sign Language}}, most students at {{abbr|LSD|Louisiana School for the Deaf}} prefer texting their parents directly.	High school students staying overnight on the Louisiana School for the Deaf (LSD) campus can phone their parents using an American Sign Language (ASL) interpreter. Although fluent in ASL, most students at LSD prefer texting their parents directly.

In the above example, each abbreviation is first expanded in the body text within parentheses. The template provides an additional way for some users to access the meaning later in the text. See MOS:ABBR for more information.

Less accessible when used in place of inline expansion

Markup	Renders as
High school students staying overnight on the {{abbr|LSD|Louisiana School for the Deaf}} campus can phone their parents using an {{abbr|ASL|American Sign Language}} interpreter. Although fluent in {{abbr|ASL|American Sign Language}}, most students at {{abbr|LSD|Louisiana School for the Deaf}} prefer texting their parents directly.	High school students staying overnight on the LSD campus can phone their parents using an ASL interpreter. Although fluent in ASL, most students at LSD prefer texting their parents directly.

In the above example, all abbreviations are expanded via the template. This is discouraged because it is the only way for users to access the meaning. Users reading on a mobile device, reading a printout, or listening to a screen reader will likely not have access to the full meaning.

Least accessible when misused to create tooltip notes

Markup	Renders as
High school students staying overnight on the {{abbr|LSD|Louisiana School for the Deaf}} campus can phone their parents using an {{abbr|ASL|American Sign Language}} {{abbr|interpreter|Although fluent in ASL, most students at LSD prefer texting their parents directly.}}.	High school students staying overnight on the LSD campus can phone their parents using an ASL interpreter.

In the above example, all abbreviations are expanded via the template, and an entire sentence is embedded via the template. It is the only way for users to access the meaning. A user reading on a mobile device, reading a printout, or listening to a screen reader will likely not have access to the full meaning of the abbreviation and will have no clear indication that the embedded footnote exists.

Tooltip example

Markup	Renders as
[[WP:COI|{{tooltip|conflict of interest|in the specific sense employed in Wikipedia policy}}]]	conflict of interest

Tooltips should not be used within the body text of an article if possible (see MOS:NOTOOLTIPS). Generic tooltip notes are not a substitute for footnotes and are intended to be used for navigational and other secondary features where space is limited. See Template:Glossary link or Template:Cite book/doc#Usage for practical examples.

Linking

To wiki-link the abbreviation being marked up by this template, wrap the template in the link, or the tooltip will not appear in some browsers.

Compatibility	Markup	Renders as
Compatible	[[Knockout#Technical knockout|{{abbr|TKO|technical knockout}}]]	TKO
Less compatible	{{abbr|[[Knockout#Technical knockout|TKO]]|technical knockout}}	TKO

Accessibility and validity

The {{Abbr}} 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. 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 (it will falsely pass a 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).

Redirects

The following template names will redirect to {{Abbr}}:

• {{Abbrv}}
• {{Define}}

{{Tooltip}} is a separate template sharing the same documentation.

Maintenance categories

• Category:Pages using tooltip with unknown parameters (9)

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Abbr in articles based on its TemplateData.

TemplateData for Abbr

An abbreviation or acronym with a tooltip displayed on mouse-over.

Template parameters[Edit template data]

Parameter		Description	Type	Status
Term	1	Shows as text	Line	required
Meaning	2	Shows as a mouse-over tooltip; do not use markup	String	required
CSS	style	applies the specified CSS directives to the content of parameter 1	String	optional
Class	class	Adds a one or more CSS classes	String	optional
ID	id	Adds an HTML id (must be unique in the page)	String	optional

See also

• {{Abbrlink}}, a variant of this template that includes automatic wikilinking of the term (abbreviation).
• {{dfn}}

The above documentation is transcluded from Template:Abbr/doc. (edit | history)
Editors can experiment in this template's sandbox (edit | diff) and testcases (edit) pages.
Add categories to the /doc subpage. Subpages of this template.