自定义显示版本

当版本标识符包含大写字母、符号或空格时，在参考 UI 中 display_version 严格用于表示目的。它不会影响资源id、可发布资源 url 中的版本段，也不会影响组件版本的排序方式。

display_version键

display_version 是可选的。它在组件版本的 antora.yml 中设置。在显示版本的地方，由引用 UI 使用，包括组件版本选择器和页面版本选择器。

如果未设置 display version ，则引用 UI 回退到版本键。与 version 不同，display version 的值可以包含空格，大写字母和大多数字符(例如，3.0 Beta, RED WREN!, rawhide)。

Example 1. Example 1. antora.yml
name: colorado
title: Colorado ∆
version: '5.6'
display_version: '5.6 EOL' (1)
1 如果值以数字开头，请将其括在一组单引号( ' )中。

当一个版本包含会破坏 Antora 的资源 id 、阻止 web 服务器之间的可移植性、不建议在 url 中使用的空格或字符时，应该使用显示版本(display_version)键。当组件版本是预发布、未版本化或存档时，它很有用，因为显示版本(display_version)的值不会影响可发布的资源 url 和资源 id 。

TIP

预发布键提供了额外的 UI 路由、排序和表示功能。当设置了这两个键时，显示版本键的值将显示在 UI 中，而从预发布标识符生成的计算预发布版本将用于排序和路由。

要了解有关 Antora 如何使用显示版本键并将其与其他版本(实际版本、预发布版本和符号版本)进行比较的更多信息，请参见 version facets 。

为组件版本指定显示版本

让我们展开您之前学习了如何分配组件名称和版本的 antora.yml 示例。Silver Leaf 项目团队希望在 UI 中显示版本代码名称和版本号。由于版本不能包含空格，所以在组件版本 antora.yml 中设置显示版本。

  1. 在您选择的文本编辑器或IDE中打开组件版本 antora.yml 文件。

    Example 2. Example 2. antora.yml for the component version silver-leaf 7.1
    name: silver-leaf
title: Silver Leaf
version: '7.1'

  2. 在新行中输入 display_version ，后跟冒号( : )。

  3. 在冒号后插入空格，然后键入要分配给 display_version 的值。由于该值以数字开头，因此将其括在一组单引号(')中。

    name: silver-leaf
title: Silver Leaf
version: '7.1'
display_version: '7.1 Spiny'

  4. 保存文件

现在，UI 将在组件版本选择器和页面版本选择器中显示 7.1 Spiny 。