页面交叉引用和导航文件中的链接文本
页面交叉引用
导航列表中对页面的交叉引用是使用AsciiDoc xref宏和页面的资源ID构建的。
导航文件列表中的交叉引用通常指向与导航文件相同模块中的页面。在这些情况下,资源ID不需要版本、组件或模块坐标。但是,无论导航文件属于哪个组件版本,您仍然可以从任何导航列表链接到站点中的任何页面,无论它们属于不同模块还是组件。
示例 1. nav.adoc
* xref:filename.adoc[可选链接文本] (1)
* xref:module:filename.adoc[] (2)
* xref:version@component:module:filename.adoc[] (3)
1 | 指向同一模块中页面的交叉引用。该交叉引用还指定了链接文本。 |
2 | 同一组件版本中的页面,但是不同模块。 |
3 | 另一个文档组件中的页面。 |
导航文件中的交叉引用可以使用目标页面的默认导航链接文本,或者在宏的方括号([]
)内指定链接文本。无论是默认链接文本还是在交叉引用中指定的链接文本,都会显示在组件版本的页面菜单中。当访问者点击链接文本时,它们将被路由到交叉引用中指定的目标页面。链接文本,无论是默认链接文本还是在交叉引用中指定的,也会显示在目标页面顶部的面包屑中。
使用默认导航链接文本
导航文件中的交叉引用不需要指定链接文本。
示例 2. nav.adoc
* xref:get-started.adoc[] (1)
1 | 没有在宏的方括号([] )内指定任何链接文本的交叉引用。 |
当链接文本未指定时,Antora使用目标页面中可选的navtitle属性的值。当目标页面的头部未设置navtitle
时,Antora会自动将其分配为页面的引用文本的值,这可能是目标页面的默认引用文本或分配给reftext属性的文本。
当在页面的资源ID后附加片段时,Antora不会填充交叉引用的链接文本。在这种情况下,您仍然需要明确指定链接文本。 |
在交叉引用中指定链接文本
您可以直接在交叉引用宏中输入链接文本,并覆盖目标页面提供的默认链接文本。
示例 3. nav.adoc
.特殊项目
* xref:index.adoc[什么是银叶] (1)
** xref:ROOT:get-started.adoc#prereqs[安装先决条件] (2)
** xref:team::contributing.adoc[] (3)
.支持
* xref:help.adoc[*故障排除*] (4)
1 | 在交叉引用宏的方括号([] )之间输入链接文本。 |
2 | 目标页面的资源ID后附加片段的交叉引用应指定链接文本。 |
3 | 此交叉引用将使用目标页面的默认导航链接文本。 |
4 | 指定的链接文本可以使用内联格式化语法标记。 |
在交叉引用宏中指定的链接文本将显示在组件版本页面菜单中。