添加行内图像
在此页面上,您将学习:
-
Asciidoc 内联图像宏的结构。
-
如何使用其资源ID插入内联图像。
AsciiDoc 内联图像宏
AsciiDoc 内联图像宏用于将图像的源文件嵌入到部分或页面中。内联图像宏接受 PNG、JPG、SVG和GIF (静态和动画)图像文件的 Antora 资源ID作为值。
当 Antora 运行时,内联图像宏引用的图像文件被嵌入到另一个元素(如侧边栏块)的流中,并显示在发布的页面中。例如,这是一个使用内联图像宏嵌入到该段落中的 SVG 图像。
内联图像宏结构
示例1显示了内联图像宏的结构。
This sentence contains an inline image:resource-id-of-target-image.ext[optional attribute,optional attribute] image. (1)
1 | 将内联图像输入到内容流中。它由宏名称后面的单个冒号( : )指定。 |
至少,内联图像宏由宏前缀(
)组成。目标图像是当前页面引用的图像源文件。将其资源 ID 分配给当前页面内容中的内联或块状图像宏以引用目标图像。当前页面是包含引用目标图像的图像宏的页面源文件。
下面将更详细地描述示例1中显示的内联图像宏的每个部分。
- image:
-
内联图像宏以宏的名称 image 开头,后面跟着一个冒号(
:
)。 - resource ID of target image
-
图像宏接受图像源文件的资源 ID 作为其值。该值直接在跟随宏名称(
image:
)的冒号之后输入。需要指定目标图像的资源ID坐标取决于目标图像相对于当前页面的组件版本和模块。当从图像宏引用图像时,您无需在目标图像的资源ID中包含image$
族坐标。它会在运行时自动应用。 - [optional attribute,optional attribute]
-
内联图像宏在目标图像的资源 ID 的末尾用一组方括号(
[]
)完成。可以将括号保留为空,也可以将一个或多个可选属性分配为方括号内的逗号分隔列表。
下一节 嵌入内联图像 将逐步解释如何设置内联图像宏。
嵌入内联图像
让我们分解内联图像宏和使用内联图像宏将图像(目标图像)插入页面(当前页面)所需的资源ID坐标。
-
在您的 IDE 或文本编辑器中打开要插入图像的页面。在此练习中,我们打开了文件
satellites.adoc
。satellites.adoc
是当前页面。 -
在
satellites.adoc
中,让我们嵌入内联图像blue-dot.svg
。选择您想要目标图像显示的当前页面的内容流中的位置。输入宏的名称后跟一个冒号(image:
)。Example 2. Example 2. satellites.adoc (current page)Look for the image:
-
在冒号后直接输入目标镜像文件的资源ID。在本例中,
blue-dot.svg
和satellites.adoc
属于相同的组件版本和模块,目标映像存储在images
族目录的根目录中。因此,只需要将blue-dot.svg
的文件名和扩展名分配为内联图像宏的值。Example 3. Example 3. satellites.adoc (current page)Look for the image:blue-dot.svg
注意,
blue-dot.svg
的资源 ID 不包括它的族坐标。Antora 自动将image$
族坐标应用于分配给图像宏的资源 ID 。 -
在目标图像的资源 ID 后面,直接输入一个左方括号(
[
),然后输入一个右方括号(]
)。Example 4. Example 4. satellites.adoc (current page)Look for the image:blue-dot.svg[]
在这个例子中,我们没有对内联图像宏应用任何可选属性;但是,您可以将一个或多个属性指定为方括号内的逗号分隔列表。
-
在最后一个方括号(
]
)后按一次kbd:[SPACE]空格键,在宏后面插入一个空格,然后继续输入内容。Example 5. Example 5. satellites.adoc (current page)Look for the image:blue-dot.svg[] on the console.
就是这样!您已经使用 AsciiDoc
内联图像宏将目标图像( blue-dot.svg
)插入到当前页面( satellites.adoc
)中。
了解更多
要了解如何嵌入属于其他模块、文档组件和版本的图像,请参见 图像资源ID示例。