生成器事件参考

当Antora运行时,Antora扩展会监听生成器发出的事件。每个监听器都可以访问在事件发出时处于范围内的变量。以下表格按照它们被发出的顺序列出了生成器事件以及对应于每个事件的上下文(范围内)变量。如果变量被锁定,意味着它无法被替换,那么它会被斜体显示。

表1. Antora扩展事件和范围内变量
事件名称 范围内变量

register()[1]

playbook, config

contextStarted[2]

playbook

playbookBuilt

playbook

beforeProcess

playbook, siteAsciiDocConfig, siteCatalog

contentAggregated[3]

playbook, siteAsciiDocConfig, siteCatalog, contentAggregate

uiLoaded[3]

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog

contentClassified

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

documentsConverted

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

navigationBuilt

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog, navigationCatalog

pagesComposed

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

redirectsProduced

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

siteMapped[4]

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

beforePublish

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog

sitePublished

playbook, siteAsciiDocConfig, siteCatalog, uiCatalog, contentCatalog, publications

contextStopped

(在上下文停止时仍处于范围内的任何变量)

contextClosed[5]

(在上下文关闭时仍处于范围内的任何变量)

除了在此表格中列出的内置上下文变量外,您的扩展还可以访问其他扩展文档化并发布的上下文变量。


1. register函数不是一个事件,而是Antora在扩展上调用的函数,以便它可以注册监听器。
2. 直到此事件被发出之前,内置生成器函数是不可用的。
3. 相对于彼此,contentAggregateduiLoaded事件的顺序不能保证。
4. 只有在playbook中指定了站点URL时,才会发出siteMapped事件。
5. contextClosed事件的监听器应该捕获自己的错误,以便通知所有监听器。