Abbr
Use the abbr shortcode to show the long form of an abbrevitation.
Use the abbr shortcode to show the long form of an abbrevitation on hover. The abbreviation data is retrieved from a central data file. By default, the shortcode uses “data/abbr.yaml” with translation support.
{{< abbr HTML >}}
{{< abbr key="html" class="initialism" >}}The shortcode supports a single unnamed argument, which maps to the key argument. When using named parameters, the following arguments are supported:
| Name | Type | Required | Default | Comment |
|---|---|---|---|---|
| class | string | Class attribute of the abbr element. For example, specify initialism for a slightly smaller font size. |
||
| data | string | abbr.yaml | Filename of the abbrevation input. You can omit the file extension. The file should reside in the data folder. The data supports language extensions. For example, abbr.en.yaml refers to the English translation of the abbrevation data. The filename abbr.yaml is used when no suitable translation is found. |
|
| key | string | yes | Case-insensitive key of the abbreviation. In shorthand notation, this is the first (and only) matched argument. Non-alphanumeric keys must be quoted. |
Define a file in the data folder that contains the abbreviation data. The format expects the following attributes:
| Attribute | Required | Description |
|---|---|---|
| id | Yes | Required key of the abbeviation. Store the key in lower case to ensure it can be matched. |
| long | Yes | Required long form of the abbreviation. |
The following snippet defines three entries in yml format.
- id: css
long: "Cascading Style Sheets"
- id: html
long: "HyperText Markup Language"
- id: svg
long: "Scalable Vector Graphics"