Template:Abbr/doc
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
Usage
Note Parameter order reversed! Be aware that, for historical reasons, the order of these parameters is reversed from implementations of {{Abbr}} at most other wikis, including Wikipedia.
The template takes two unnamed parameters.
1
- meaning – the expansion or definition of the abbreviated term; shows as the popup when you hover over the abbreviation. No wikimarkup can be used in this parameter.
2
- 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.
Example
Markup | Renders as |
---|---|
{{abbr|Wikimedia Foundation|WMF}} |
WMF |
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 | [[meta:Wikimedia Foundation|{{abbr|Wikimedia Foundation|WMF}}]]
|
WMF |
Less compatible | {{abbr|Wikimedia Foundation|[[meta:Wikimedia Foundation|WMF]]}}
|
WMF |
Template data
This is the TemplateData documentation for this template used by VisualEditor and other tools.
Abbr/doc
<TemplateData> {
"description": { "en": "define an abbreviation or acronym, by creating a tooltip that is displayed on mouse-over", "de": "Abkürzung oder Akronym definieren, und die Erklärung anzeigen wenn der Mauszeiger über dem Text schwebt" }, "params": { "1": { "label": { "en": "Meaning", "de": "Bedeutung" }, "description": { "en": "Shows as tooltip", "de": "Wird als Tooltip angezeigt" }, "type": "string", "required": false, "suggested": true, "example": "Wikimedia Foundation" }, "2": { "label": { "en": "Abbreviation", "de": "Abkürzung" }, "description": { "en": "Shows as regular text on the page", "de": "Wird regulär präsentiert" }, "type": "content", "required": false, "suggested": true, "example": "WMF" } }
} </TemplateData>
See also
- {{Clarify }}, which produces the inline superscript [<span title="<translate> The text in the vicinity of this tag needs clarification or removal of jargon</translate>"><translate> clarification needed</translate>]