Question

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

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

documentation表示“缩写元素未在默认重组文本中公开。只能通过自定义角色访问。”我不确定如何创建这样的自定义角色，the rest of the文档对我来说有点模糊。

Answer 1

我现在通过在文档底部添加它来解决它：

.. |HTMLabbr| raw:: html

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

然后在文档中，我使用了这个＆＃34;标记＆＃34; /自定义角色，如下所示：

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

对于每个缩写，您必须定义一个新的自定义角色，我想知道是否有办法获得＆＃34;标记＆＃34;将值和标题作为参数，而不是像这样硬编码。

Answer 2

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

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

产生以下HTML

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

Answer 3

创建自定义文档的第一个角色并不难（与其他方法相比如何扩展docutils）。请参阅rst roles howto，其中包含所有详细信息以及示例RFC角色的完整实现。我能够根据此文档创建自定义bugzilla referencing role。