reStructuredText中的缩写(abbr)元素

Question

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

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

文档表示“在默认的重构文本中不公开缩写元素。它只能通过自定义角色访问。”我不知道如何创建这样一个自定义角色，这个 休息 的 这个文档对我来说有点模糊。

Answer 1

我现在通过在文件底部添加以下内容来解决这个问题：

.. |HTMLabbr| raw:: html

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

然后，在文档中，我使用了这样的“标记”/custom角色：

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

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

Answer 2

对于狮身人面像用户，可以使用:abbr:角色添加缩写。例如,

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

结果显示了以下HTML

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

Answer 3

创建自定义docutils rst角色并不难(与如何扩展docutils的其他方式相比)。请参阅rst角色操作，它包含所有细节以及示例RFC角色的完整实现。我能够基于这个文档创建自定义bugzilla引用角色。