I would like to see inline support for <abbr>
tags.
The
abbr
element represents an abbreviation or acronym, optionally with its expansion. Thetitle
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.
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.The
<abbr>
tag is already supported by the HTML5 writer, see https://docutils.sourceforge.io/test/functional/expected/standalone_rst_html5.html#text-level-semantics and the sourcehttps://docutils.sourceforge.io/test/functional/input/data/html5-text-level-tags.txt.
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
Depends an a solution for [#68] "Adding syntax for role parameters".
Related
Feature Requests: #68