自定义reftext和navtitle

当 Antora 运行时,reftextnavtitle 属性会自动设置并分配默认值。您可以通过在页眉中设置这些属性来自定义它们的值。

reftext属性

目标页面的 reftext 值在源自页面或资源文件的 xref 中用作链接文本。默认情况下,Antora 将在运行时将页面的标题分配给 reftext 属性。在示例1中,让我们引用 install-prerequisites.adoc 文件并将链接文本字段留空。

Example 1. Example 1. current-page.adoc
Make sure you xref:install-prerequisites.adoc[].

现在,让我们查看 install-prerequisites.adoc 文件的标题。

Example 2. Example 2. install-prerequisites.adoc
= Installing and Testing Silver Leaf's Prerequisites

Here are the prerequisites:

请注意,在示例2中,页面的标题中没有设置 reftext 。这意味着其标题,Installing and Testing Silver Leaf’s Prerequisites,将在运行时自动分配给 reftext ,并在示例1中用作 xref 的链接文本。

如果不希望将页面标题用作其默认 reftext ,请使用属性条目为该属性分配一个自定义值。示例3显示了为 reftext 属性分配自定义值。

Example 3. Example 3. Assign a custom reftext value
= Installing and Testing Silver Leaf's Prerequisites
:reftext: Install Silver Leaf's Prerequisites

Here are the prerequisites:

当生成站点时,reftextInstall Silver Leaf’s Prerequisites 将在示例1中用作 xref 的链接文本。它也将用作页面的 navtitle 值。

CAUTION

当目标页面的资源ID与片段一起追加时,链接文本不会自动填充。在这种情况下,您需要指定 xref 链接文本。

navtitle属性

目标页面的 navtitle 值用作源自 导航文件xref 中的链接文本。默认情况下,Antora 将页面的 reftext 属性的值分配给 navtitle 。 页面的 reftext 通常被自动指定为页面的标题。

在示例4中,让我们在导航文件中引用 get-started.adoc ,并将链接文本字段保留为空。

Example 4. Example 4. nav.adoc
* xref:index.adoc[]
* xref:get-started.adoc[]

现在,让我们看一下示例5中 get-started.adoc 的头部。

Example 5. Example 5. get-started.adoc
= Get Started with Silver Leaf

Let's get started!

请注意,在其标题中既未设置 reftext 也未设置 navtitle 。这意味着页面的标题 Get Started with Silver Leaf 将自动分配给 reftext ,因此自动分配给 navtitle ,并用于填充导航文件中的 xref 链接文本。

如果您不想将页面的默认或自定义 reftext 值分配为默认 navtitle ,请使用属性条目为属性分配自定义值。示例6展示了将 navtitle 属性分配自定义值。

Example 6. Example 6. Assign a custom navtitle value
= Get Started with Silver Leaf
:navtitle: Getting Started

Let's get started!

当生成站点时,navtitle (Getting Started) 的值将填充导航文件中的 xref 链接文本。

CAUTION

当目标页面的资源ID附加有片段(也称为深度链接),并且在方括号之间未指定链接文本,例如 xref:page.adoc#fragment[] 时,链接文本不会自动填充。当使用片段时,您需要在 xref 宏中指定链接文本。