描述列表

在本页面上,您将学到:

  • 如何使用AsciiDoc标记描述列表。

  • 如何在描述内容中添加其他AsciiDoc元素。

描述列表,也称为定义列表,提供了一组术语或短语及其描述。

描述列表语法

描述列表中的每个项目由一个术语或短语后跟:

  • 两个连续冒号的分隔符(::),

  • 然后至少一个空格或换行符,

  • 最后,项目的描述或定义。

基本描述列表

以下是一个包含两个术语及其内容的描述列表示例。

键盘::
用于在屏幕上输入文本或控制项目。 (1)
鼠标:: 用于指向并选择计算机屏幕上的项目。 (2)
1 术语及其描述可以放在不同的行上。
2 只要在::和描述内容之间至少有一个空格,术语及其描述可以放在同一行上。

在呈现时,每个项目的描述显示在术语下方。

键盘

用于在屏幕上输入文本或控制项目。

鼠标

用于指向并选择计算机屏幕上的项目。

描述列表的内容可以是任何AsciiDoc元素。甚至可以包含其他类型的列表。

复杂描述列表

让我们看一个包含单独段落以外内容的示例。

示例1. 包含复杂内容的描述列表
术语1::
这个描述需要两个段落。
要将它们都连接到术语1,使用在分隔段落的行上的列表继续符号(+)。
+
这是术语1的第二段。

术语2:: 这个描述包括一个警告块。
像额外的段落一样,块也需要用+连接。
+
注意:作为术语2描述的警告块。

术语3::
* 无序列表项
.. 有序列表项
... 另一个有序列表项

这是示例1的结果。

术语1

这个描述需要两个段落。要将它们都连接到术语1,使用在分隔段落的行上的列表继续符号(+)。

这是术语1的第二段。

术语2

这个描述包括一个警告块。像额外的段落一样,块也需要用+连接。

作为术语2描述的警告块。
术语3
  • 无序列表项

    1. 有序列表项

      1. 另一个有序列表项

有关将多个块连接到列表项的复杂列表示例和信息请参阅有序和无序列表页面。

AsciiDoc和Asciidoctor资源