自定义显示版本

display_version键严格用于参考UI中的展示目的，当版本标识符包含大写字母、符号或空格时。它不影响资源ID、可发布资源URL中的版本段，或组件版本如何排序。

display_version键

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

如果未设置display_version，参考UI将退回到版本键。与version不同，display_version的值可以包含空格、大写字母和大多数字符（例如，3.0 Beta，RED WREN!，rawhide）。

示例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没有影响，因此很有用。

当同时设置这两个键时，预发行版键提供额外的UI路由、排序和展示功能。虽然在UI中显示display_version键的值，但从预发行标识符生成的计算预发行版本用于排序和路由。

要了解Antora如何使用display_version键，并将其与其他版本要素（实际版本、预发行版本和符号版本）进行比较，请参阅版本要素。

为组件版本分配display_version

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

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

    示例2. 用于组件版本 silver-leaf 7.1 的 antora.yml 
    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。