导航文件中的页面 xref 和链接文本

页面 xrefs

对导航列表中页面的交叉引用是使用 AsciiDoc xref 宏和页面的资源 ID 构造的。

导航文件列表中的 xref 通常针对与导航文件属于同一模块的页面。在这些情况下,资源id不需要版本、组件或模块坐标。但是,无论导航文件属于哪个组件版本,您仍然可以从任何导航列表链接到站点中的任何页面,不管它们属于不同的模块或组件。

Example 1. Example 1. nav.adoc
* xref:filename.adoc[Optional link text] (1)
* xref:module:filename.adoc[] (2)
* xref:version@component:module:filename.adoc[] (3)
1 Xref 指向同一模块中的页面。xref 还指定链接文本。
2 页面在相同的组件版本,但不同的模块。
3 另一个文档组件中的页面。

导航文件中的 xref 可以使用目标页面的默认导航链接文本,也可以在宏的方括号中指定链接文本。链接文本将在组件版本的页面菜单中显示。当访客单击链接文本时,它们会被路由到 xref 中指定的目标页面的资源 ID 。链接文本无论是默认链接文本还是在在 xref 中指定的,都显示在目标页面的顶部的面包屑中。

使用默认的导航链接文本

导航文件中的 xref 不需要指定链接文本。

Example 2. Example 2. nav.adoc
* xref:get-started.adoc[] (1)
1 在宏的方括号( [] )中没有指定任何链接文本的 xref

当链接文本未指定时,Antora 使用分配给目标页面中可选的 navtitle 属性的值。如果没有在目标页面的标题中设置 navtitle ,那么 Antora 将自动为其分配页面引用文本的值,该值可以是目标页面的默认引用文本,也可以是分配给 reftext 属性的文本。

NOTE

当片段被附加到页面的资源 ID 时,Antora 不会填充 xref 链接文本。在这种情况下,您仍然需要显式地指定链接文本。

在 xref 中指定链接文本

您可以直接在 xref 宏中输入链接文本,并覆盖目标页面提供的默认链接文本。

Example 3. Example 3. nav.adoc
.The Special Project
* xref:index.adoc[What's Silver Leaf] (1)
** xref:ROOT:get-started.adoc#prereqs[Installation Prerequisites] (2)
** xref:team::contributing.adoc[] (3)

.Support
* xref:help.adoc[*Troubleshooting*] (4)
1 xref 宏的方括号( [] )之间输入链接文本。
2 目标页面的资源 ID 与片段一起附加的 xref 应该指定链接文本。
3 这个 xref 将使用目标页面的默认导航链接文本。
4 可以用内联格式语法标记指定的链接文本。

xref 宏中指定的链接文本将显示在组件版本页菜单中。