Template:Abbr/doc
This is a documentation subpage for Template:Abbr It contains usage information, categories and other content that is not part of the original template page. |
{{abbr}} is an abbreviation template. It works similarly to the HTML <abbr> or <acronym> tags.
Usage
edit{{abbr}} takes two unnamed parameters, in order:
- The short form, which shows as text on the page.
- The long form, which the short form is an abbreviation for.
Many web browsers (such as Firefox, Google Chrome, Internet Explorer, Opera, Safari) show the long form as a tooltip when a user hovers over the text. However, this behavior is not guaranteed and should not be relied on.
There is an option for a third parameter: adding "unicode" (or "u") applies {{unicode}} to the text of parameter 1. This may resolve rendering issues with browsers which do not apply the proper font to the text. Other fonts/languages may be added to the code as needed. If the third parameter is not defined, it will be ignored.
Example with two parameters
edit{{abbr |MSLP |Mean Sea Level Pressure }}
appears as MSLP. When hovering over the text, something like Mean Sea Level Pressure appears as a tooltip in many (but not all) browsers. Popular screen readers, used by visually impaired readers, display the long form in a different way.
Example with three parameters
edit{{abbr |pȅći • пе̏ћи |to say |unicode }}
appears as pȅći • пе̏ћи. Compare pȅći • пе̏ћи without the Unicode formatting.
Accessibility concerns
editThis 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
editThe following template names redirect to this one:
See also
edit- Template:Abbrlink - Wikilinks the content too.
- Template:R-phrase - Generate 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.