Template:Abbr/doc

From Guild of Archivists
< Template:Abbr
Revision as of 04:24, 29 November 2024 by Pharap (talk | contribs) (Create documentation page for 'Abbr' template using TemplateData.)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

A template that behaves similarly to the {{tlx|hover text}} template in that it provides both page content text and text that appears when that page content text is hovered over, but is specifically designed to be used with abbreviations. ''Note'': Despite behaving similarly to {{tlx|hover text}}, the order of the parameters differs due to the two templates having different intended uses. ''Example'': {{abbr|DRC|D'ni Restoration Council}}

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Abbreviation1 shortform

The abbreviation that will be included directly into the page text.

Example
DRC
Stringoptional
Full Text2 longform

The full text of which the abbreviation is a shortened form. The text that shall appear when the abbreviation in the page text is hovered over.

Example
D'ni Restoration Council
Stringrequired