#96 <abbr> abbreviations tag

[toastal]

I would like to see inline support for <abbr> tags.

The abbr element represents an abbreviation or acronym, optionally with its expansion. The title attribute may be used to provide an expansion of the abbreviation. The attribute, if specified, must contain an expansion of the abbreviation, and nothing else.

https://html.spec.whatwg.org/multipage/text-level-semantics.html#the-abbr-element

These are useful for jargon-heavy content like documentation and can help with accessibility.

[toastal]

Perhaps this is covered by https://docutils.sourceforge.io/docs/ref/rst/roles.html :ab: and :ac: although I don’t see a way to add the title.

[Günter Milde]

Yes, there is native support for abbreviations in Docutils with the "abbreviation" role (alias "ab") and <abbreviation></abbreviation> Document-Tree element.
The HTML writers convert it to an <abbr> element (cf. the test output for Text Level Semantics and the source).

However, there is currently no way to specify the expansion (the "title"). rST inline roles syntax is not suited for cases requiring 2 arguments (here, the title and the abbreviation).
Unfortunately, there is no clear solution:
https://docutils.sourceforge.io/docs/dev/rst/alternatives.html#parameterized-interpreted-text

[Günter Milde]

Depends an a solution for [#68] "Adding syntax for role parameters".