自定义 reftext 和 navtitle

reftextnavtitle 属性在 Antora 运行时会自动设置并分配默认值。您可以通过在页面头部设置这些属性来自定义这些属性的值。

reftext 属性

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

示例 1. current-page.adoc
确保您 xref:install-prerequisites.adoc[].

现在,让我们看一下 install-prerequisites.adoc 文件的头部。

示例 2. install-prerequisites.adoc
= 安装和测试 Silver Leaf 的先决条件

以下是先决条件:

请注意,在示例 2中,页面的头部未设置 reftext。这意味着其标题,安装和测试 Silver Leaf 的先决条件,将在运行时自动分配给 reftext 并在示例 1中用作 xref 的链接文本。

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

示例 3. 分配自定义 reftext 值
= 安装和测试 Silver Leaf 的先决条件
:reftext: 安装 Silver Leaf 的先决条件

以下是先决条件:

生成站点时,reftext 的值,安装 Silver Leaf 的先决条件,将用作示例 1中 xref 的链接文本。它还将用作页面的 navtitle 值。

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

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

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

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

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

示例 5. get-started.adoc
= 开始使用 Silver Leaf

让我们开始吧!

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

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

示例 6. 分配自定义 navtitle 值
= 开始使用 Silver Leaf
:navtitle: 开始

让我们开始吧!

生成站点时,navtitle 的值,开始,将填充导航文件中的 xref 链接文本。

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