如何使用 reStructuredText 编写标注?

发布于 2024-07-24 17:10:37 字数 300 浏览 2 评论 0原文

Asciidoc 支持 标注。 如何使用 reStructuredText 编写类似的标注?

Asciidoc supports callouts. How can one write similar callouts using reStructuredText?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

梦里兽 2024-07-31 17:10:37

似乎没有内置的等效项,但很容易制作类似于 asciidoc 文档中给出的示例的东西:

.. topic:: MS-DOS directory listing

   ::

     10/17/97   9:04         <DIR>    bin
     10/16/97  14:11         <DIR>    DOS            <1>
     10/16/97  14:40         <DIR>    Program Files
     10/16/97  14:46         <DIR>    TEMP
     10/17/97   9:04         <DIR>    tmp
     10/16/97  14:37         <DIR>    WINNT
     10/16/97  14:25             119  AUTOEXEC.BAT   <2>
      2/13/94   6:21          54,619  COMMAND.COM    <2>
     10/16/97  14:25             115  CONFIG.SYS     <2>
     11/16/97  17:17      61,865,984  pagefile.sys
     2/13/94   6:21           9,349  WINA20.386      <3>

   1. This directory holds MS-DOS.
   2. System startup code for DOS.
   3. Some sort of Windows 3.1 hack.

唯一缺少的是标记上的突出显示。 如果这些对您非常重要,您可以使用 parsed-literal 块:

.. topic:: MS-DOS directory listing

   .. parsed-literal::

      10/17/97   9:04         <DIR>    bin
      10/16/97  14:11         <DIR>    DOS            **<1>**
      10/16/97  14:40         <DIR>    Program Files
      10/16/97  14:46         <DIR>    TEMP
      10/17/97   9:04         <DIR>    tmp
      10/16/97  14:37         <DIR>    WINNT
      10/16/97  14:25             119  AUTOEXEC.BAT   **<2>**
       2/13/94   6:21          54,619  COMMAND.COM    **<2>**
      10/16/97  14:25             115  CONFIG.SYS     **<2>**
      11/16/97  17:17      61,865,984  pagefile.sys
      2/13/94   6:21           9,349  WINA20.386      **<3>**

   1. This directory holds MS-DOS.
   2. System startup code for DOS.
   3. Some sort of Windows 3.1 hack.

如果您有很多这样的标注,那么我建议为它们创建一个自定义指令。

There does not seem to be a built-in equivalent, but it is easy to make something that looks similar to the example given in the asciidoc documentation:

.. topic:: MS-DOS directory listing

   ::

     10/17/97   9:04         <DIR>    bin
     10/16/97  14:11         <DIR>    DOS            <1>
     10/16/97  14:40         <DIR>    Program Files
     10/16/97  14:46         <DIR>    TEMP
     10/17/97   9:04         <DIR>    tmp
     10/16/97  14:37         <DIR>    WINNT
     10/16/97  14:25             119  AUTOEXEC.BAT   <2>
      2/13/94   6:21          54,619  COMMAND.COM    <2>
     10/16/97  14:25             115  CONFIG.SYS     <2>
     11/16/97  17:17      61,865,984  pagefile.sys
     2/13/94   6:21           9,349  WINA20.386      <3>

   1. This directory holds MS-DOS.
   2. System startup code for DOS.
   3. Some sort of Windows 3.1 hack.

The only thing this lacks is the highlights on the markers. If those are very important to you, you can use a parsed-literal block:

.. topic:: MS-DOS directory listing

   .. parsed-literal::

      10/17/97   9:04         <DIR>    bin
      10/16/97  14:11         <DIR>    DOS            **<1>**
      10/16/97  14:40         <DIR>    Program Files
      10/16/97  14:46         <DIR>    TEMP
      10/17/97   9:04         <DIR>    tmp
      10/16/97  14:37         <DIR>    WINNT
      10/16/97  14:25             119  AUTOEXEC.BAT   **<2>**
       2/13/94   6:21          54,619  COMMAND.COM    **<2>**
      10/16/97  14:25             115  CONFIG.SYS     **<2>**
      11/16/97  17:17      61,865,984  pagefile.sys
      2/13/94   6:21           9,349  WINA20.386      **<3>**

   1. This directory holds MS-DOS.
   2. System startup code for DOS.
   3. Some sort of Windows 3.1 hack.

Should you have very many of these callouts, then I suggest making a custom directive for them.

贵在坚持 2024-07-31 17:10:37

您可以使用 parsed-literal 块以及脚注或超链接的标准 rST 语法。

You may use a parsed-literal block and the standard rST syntax for footnotes or hyperlinks.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文