Template:Abbr/doc: Difference between revisions

From Path of Exile 2 Wiki
Jump to navigation Jump to search
>Wynthyst
No edit summary
(description, usage, examples)
 
(8 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{tl|abbr}} is used to define an abbreviation or acronym. It creates a [[Wikipedia:tooltip|tooltip]] that is displayed on mouse-over. It uses the [[Wikipedia:HTML|HTML]] [[Wikipedia:HTML element#General phrase elements|<abbr>]] element.
{{Documentation subpage}}
 
This template is a wrapper for the <code><nowiki><abbr></nowiki></code> tag, which is used to mark up an abbreviation and its expanded form.  


==Usage==
==Usage==
<nowiki>{{abbr}}</nowiki> takes two unnamed parameters, in order:
This template may be used to write an abbreviation while also providing its expanded form. The expanded form of an abbreviation refers to how it is read.
#The ''short form'', which shows as text on the page
 
#The ''long form'', which the short form is an abbreviation for
<pre>{{Abbr|abbreviation|expanded form}}</pre>
 
The ''only'' correct usage of this template, and the <code><nowiki><abbr></nowiki></code> tag, is to mark up abbreviations. To provide readers with supplemental information using a tooltip or hoverbox, use {{tl|tooltip}} or {{tl|hoverbox}} instead.
 
==Examples==
The abbreviation "ES" is read as "energy shield".
 
<code><nowiki>{{Abbr|ES|energy shield}}</nowiki></code> → {{Abbr|ES|energy shield}}
 
The abbreviation "dex." is read as "dexterity".
 
<code><nowiki>{{Abbr|dex.|dexterity}}</nowiki></code> → {{Abbr|dex.|dexterity}}
 
The abbreviation "CwDT" is read as "Cast when Damage Taken".
 
<code><nowiki>{{Abbr|CwDT|Cast when Damage Taken}}</nowiki></code> → {{Abbr|CwDT|Cast when Damage Taken}}


{{tlx|abbr|MSLP|Mean Sea Level Pressure}} → {{abbr|MSLP|Mean Sea Level Pressure}}
{{Adapted from Wikipedia|Template:Abbr}}


<includeonly>
{{Documentation categories|
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
<!-- Categories and interwikis go here. -->
[[Category:Templates|{{PAGENAME}}]]
[[Category:Formatting templates]]
</includeonly>
{{sister|poewiki}}
<noinclude>[[Category:Template documentation]]</noinclude>
}}

Latest revision as of 17:06, 23 March 2025

This subpage provides documentation for Template:Abbr.

This template is a wrapper for the <abbr> tag, which is used to mark up an abbreviation and its expanded form.

Usage

This template may be used to write an abbreviation while also providing its expanded form. The expanded form of an abbreviation refers to how it is read. 

{{Abbr|abbreviation|expanded form}}

The only correct usage of this template, and the <abbr> tag, is to mark up abbreviations. To provide readers with supplemental information using a tooltip or hoverbox, use {{tooltip}} or {{hoverbox}} instead.

Examples

The abbreviation "ES" is read as "energy shield".

{{Abbr|ES|energy shield}} → ES

The abbreviation "dex." is read as "dexterity".

{{Abbr|dex.|dexterity}} → dex.

The abbreviation "CwDT" is read as "Cast when Damage Taken".

{{Abbr|CwDT|Cast when Damage Taken}} → CwDT

This template was adapted from Template:Abbr on Wikipedia.
Adaptation is noted for reference and attribution only. This template may differ from the original in function or in usage.


Retrieved from "https://www.poe2wiki.net/index.php?title=Template:Abbr/doc&oldid=31481"