reStructuredText 中的缩写 (abbr) 元素

Question

如何<abbr>在 ReST 中生成缩写元素？

<abbr title="Hypertext Markup Language">HTML</abbr>

该文档指出“缩写元素未在默认重组文本中公开。它只能通过自定义角色访问。” 我不知道如何创建这样的自定义角色，并在 休息 的 该文件是一点点模糊了我。

Answer 1

对于 Sphinx 用户，可以使用:abbr:角色添加缩写。例如，

This :abbr:`SDP (Software Development Plan)` defines ...

结果在以下 HTML

<p>This <abbr title="Software Development Plan">SDP</abbr> defines …</p>

Answer 2

我现在已经通过在文档底部添加以下内容解决了这个问题：

.. |HTMLabbr| raw:: html

  <abbr title="Hypertext Markup Language">HTML</abbr>

然后在文档中我使用了这个“标签”/自定义角色，如下所示：

This document is written in |HTMLabbr| and renders nicely in a modern browser.

对于每个缩写，您必须定义一个新的自定义角色，我想知道是否有一种方法可以有一个“标签”，它将值和标题作为参数，而不必像这样对其进行硬编码。