openSUSE / agama / 8688306090

72%

Build Type

push

github

Committed by web-flow

Commit Message

web: Stop using `<abbr />` HTML tag (#1149)

Some time ago, we started using the `<abbr>` tag for providing a way to
see the full text of an acronym or abbreviation.

However, at some point in the development of #1138, we realized that
even though it is a native HTML tag, it might not be as accessible as we
originally believed. In fact, the doubt arose when considering keyboard
users: how can they ask the browser to show the title attribute? By
default, they can't.

Having a look to [tests recently made by Adrian
Roselli](https://adrianroselli.com/2024/01/using-abbr-element-with-title-attribute.html),
it can be seen that, among other issues, it's commonly problematic for
keyboard and touch users. In Adrian's words:

> Exposure continues to be inconsistent across browsers and assistive
technologies. Some set of users will always miss some piece of
information.

In addition, such an element increases the risk of overusing it by
encouraging us to over explain acronyms, as @dgdavid almost did with
_Btrfs_, which he wanted to wrap into an `abbr` tag. As other examples,
_XFS_ and _USB_ are acronyms but it isn't actually helpful for readers
to being able to read _Extended File System_ and _Universal Serial Bus_
in the context in which they are used. Similar happens with _LVM_: if
users do not know the technology it represents, reading _Logical Volume
Manager_ hardly can help them.

Thus, it's better to stop using `<abbr />` and evaluate each particular
case when an acronym is added to the UI. If its long version could be
helpful for users we should follow the Adrian recommendation:

> Explain abbreviations, acronyms, initialisms, numeronyms, etc. on
first use and then feel free to fall back to the shortened form.

It could be the case of "Full Disk Encryption (FDE)".

Run Details

1840 of 2684 branches covered (68.55%)

Branch coverage included in aggregate %.

5 of 6 new or added lines in 4 files covered. (83.33%)

12 existing lines in 1 file now uncovered.

18263 of 24185 relevant lines covered (75.51%)

31.49 hits per line