内置属性
Antora 自动将有关运行时环境、站点配置和当前页面的信息分配给各种文档和页面属性。我们把这些称为内在属性。Antora 使用这些属性将有关站点和当前页面的信息传播到 AsciiDoc 内容、扩展和 UI 模板。
与其他内置属性(如页面别名)不同，内在属性是将信息从 Antora 传递到页面的管道。因此，内在属性应该是只读的，不应该被重新赋值。
内置环境属性
内在环境属性向正在由 Antora 处理的文档（或文档扩展）传递。这些属性在站点中的每个页面上设置。
-
env=site
-
env-site
-
site-gen=antora
-
site-gen-antora
您可以在预处理器条件中使用这些属性，以根据文档是否正在由 Antora 处理来包含或排除内容。例如：
您可以在剧本中定义额外的环境属性。
站点和配置属性
Antora 设置各种属性来配置 AsciiDoc 处理器。
-
attribute-missing=warn
-
!data-uri
-
icons=font
-
sectanchors
-
source-highlighter=highlight.js
这些属性都是合理的默认值。与其他内在属性不同，它们可以使用 CLI 或 playbook 重新配置。它们也可以被重新定义，这样它们就可以被组件描述符或页面覆盖。
- CAUTION
-
Antora 目前支持的源代码块语法高亮显示只有
highlight.js。因此，将source-highlighter属性更改为任何其他值是没有意义的。如果想禁用源块上的语法高亮显示，可以禁用此属性。
Antora 还使用属性传递一般站点信息。
-
site-title
-
site-url
这些属性的值与剧本中定义的值相匹配。
内置页面属性
Antora 通过页面属性传递关于当前页面的各种信息。为每个页面以及每个 导航文件 重新分配这些属性。
| 属性 | 描述 | 示例 |
|---|---|---|
page-component-display-version |
在 |
7.1 Beta |
page-component-name |
在 antora.yml 中指定的组件版本的组件名称。 |
silver-leaf |
page-component-title |
在 antora.yml 中指定的组件版本的组件标题。 |
Silver Leaf |
page-component-latest-version |
当前页面组件中最新版本的版本字符串。 |
7.5 |
page-component-version |
在 antora.yml 中指定的组件版本号。 |
7.1 |
page-component-version-is-latest |
设置当前页面的组件版本是否为当前页面组件的最新版本。 |
empty |
page-edit-url |
可以编辑页面源文件的 URL 。 |
https://gitlab.com/forest-co/silver-leaf/edit/main/modules/ROOT/pages/index.adoc |
page-module |
页面模块的名称。 |
ROOT |
page-origin-branch |
存储页面源文件的存储库分支的名称。(与 page-origin-tag 互斥) |
v7.1.0 |
page-origin-private |
如果存储页面源文件的源是私有的，则设置。 |
empty |
page-origin-refhash |
存储页面源文件的引用的 SHA-1 哈希值。如果文件取自 git 工作树(即本地目录)，则值为( worktree )。 |
e8e6f6ba33b1ab3f796907b5a256893a64844cd1 |
page-origin-refname |
存储页面源文件的引用的名称。 |
v7.1.0 |
page-origin-reftype |
存储页面源文件的引用类型(例如，标签或分支)。如果文件取自 git工作树(即本地目录)，则值为branch。 |
branch |
page-origin-tag |
存储页面源文件的存储库标记的名称。(与 page-origin-branch 互斥) |
v7.1.0 |
page-origin-start-path |
存储页面源文件的内容源的起始路径。 |
docs |
page-origin-type |
存储页面源文件的内容源类型(例如git)。 |
git |
page-origin-url |
存储页面源文件的内容源的URL(不带凭据)。 |
|
page-origin-worktree |
git工作树的绝对路径(即本地目录)。只有当文件是从git工作树中获取时才会设置。 |
/user/projects/project-name |
page-relative-src-path |
页面源文件的族相对路径（从 |
whats-new-in-spiky.adoc |
page-version |
page-component-version 别名 |
7.1 |
请记住，AsciiDoc 处理器还分配了许多内在属性来传递有关当前文档的信息(例如，docname 和 docfilesuffix )，尽管这些不是页面属性(意味着它们没有以 page- 为前缀)。
让内置的页面属性发挥作用
可以使用属性引用语法（例如，antora-manual ）或通过页面 UI 模型使用模板变量（例如，page.attributes.component-name ）来访问这些页面属性的值。
This page belongs to the *{page-module}* module in the *{page-component-title} {page-component-version}* component version.上面示例中的属性引用输出当前页面(即您正在阅读的页面)的数据(如下所示)。
This page belongs to the page module in the Antora 3.1 component version.
由于这些是页面属性，它们将与所有其他页面属性一起被提升到页面 UI 模型的 page.attributes 映射中。可以使用属性表达式（例如，page.attributes.component-name）在 UI 模板中访问它们。
要了解页属性如何工作的更多信息，请参见 页面属性 。