v50 Steam/Premium information for editors
  • v50 information can now be added to pages in the main namespace. v0.47 information can still be found in the DF2014 namespace. See here for more details on the new versioning policy.
  • Use this page to report any issues related to the migration.
This notice may be cached—the current version can be found here.

Difference between revisions of "Template:Abbr/doc"

From Dwarf Fortress Wiki
Jump to navigation Jump to search
(Created page with "{{Documentation subpage}}__NOTOC__ <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> {{tl|abbr}} is used to define an abbreviation or acronym by creatin...")
 
m (clean up Wikipedia documentation: remove Template:Tooltip link (a different template on this wiki), templatedata, unneeded header)
Line 1: Line 1:
{{Documentation subpage}}__NOTOC__
 
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{tl|abbr}} is used to define an abbreviation or acronym by creating a [[tooltip]] that is displayed on mouse-over. The template uses the [[HTML]] [[HTML element#General phrase elements|&lt;abbr>]] element and is supported by most browsers.
+
{{tl|abbr}} is used to define an abbreviation or acronym by creating a [[Wikipedia:tooltip|tooltip]] that is displayed on mouse-over. The template uses the [[Wikipedia:HTML|HTML]] [[Wikipedia:HTML element#General phrase elements|&lt;abbr>]] element and is supported by most browsers.
  
 
== Usage ==
 
== Usage ==
Line 43: Line 42:
 
* {{Tl|Define}}
 
* {{Tl|Define}}
 
* {{Tl|Explain}}
 
* {{Tl|Explain}}
* {{Tl|Tooltip}}
 
 
== Template data ==
 
{{TemplateDataHeader}}
 
<TemplateData>
 
{
 
        "description": "This template defines an abbreviation or acronym by creating a tooltip that is displayed on mouse-over.",
 
        "params": {
 
                "1": {
 
                        "label": "Short form",
 
                        "description": "Shows as text",
 
                        "type": "string",
 
                        "required": true
 
                },
 
                "2": {
 
                        "label": "Long form",
 
                        "description": "Shows as a tooltip",
 
                        "type": "string",
 
                        "required": true
 
                },
 
                "IPA": {
 
                        "label": "IPA",
 
                        "description": "Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP",
 
                        "type": "string",
 
                        "required": false
 
                },
 
                "unicode": {
 
                        "label": "Unicode",
 
                        "description": "Applies {{unicode}} to fix strings in Unicode rendered in Internet Explorer on Windows XP",
 
                        "type": "string",
 
                        "required": false
 
                },
 
                "class": {
 
                        "label": "Class",
 
                        "description": "Adds an HTML class",
 
                        "type": "string",
 
                        "required": false
 
                },
 
                "id": {
 
                        "label": "ID",
 
                        "description": "Adds an HTML id",
 
                        "type": "string",
 
                        "required": false
 
                }
 
        }
 
}
 
</TemplateData>
 
  
 
== See also ==
 
== See also ==

Revision as of 20:06, 24 September 2013

{{abbr}} is used to define an abbreviation or acronym by creating a tooltip that is displayed on mouse-over. The template uses the HTML <abbr> element and is supported by most browsers.

Usage

{{abbr}} takes two unnamed parameters, in order:

  • short form: shows as text
  • long form: shows as the tooltip

Named parameters:

  • IPA or i: Applies {{IPA}} to fix strings in the International Phonetic Alphabet rendered in Internet Explorer on Windows XP.
  • unicode or u: applies {{unicode}} to fix strings in Unicode rendered in Internet Explorer on Windows XP.
  • class: adds an HTML class
  • id: adds an HTML id

Examples

Markup Renders as
{{abbr|MSLP|Mean Sea Level Pressure}}
MSLP

When hovering over the text "MSLP" then something like Mean Sea Level Pressure will appear as a tooltip in most browsers. Popular screen readers, used by visually impaired readers, display the long form in a different way.

Markup Renders as
{{abbr|pȅći • пе̏ћи|to say}}
pȅći • пе̏ћи
{{abbr|pȅći • пе̏ћи|to say|unicode}}
pȅći • пе̏ћи
Markup Renders as
{{abbr|UK|United Kingdom|class=country-name|id=foobar}}
UK

Accessibility concerns

This 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 element generated by this template; see section H28: Providing definitions for abbreviations by using the abbr and acronym elements.

Redirects

The following template names redirect to this one:

  • {{Define}}
  • {{Explain}}

See also

  • {{Abbrlink}}- applies a wikilink to the content
  • {{R-phrase}}- generates 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.
  • {{Clarify}}