Boost C++ 库

...世界上最受推崇和专业设计的 C++ 库项目之一。 Herb SutterAndrei Alexandrescu, C++ 编码标准

PrevUpHomeNext

理解 AutoIndex 工作流程

  1. 加载脚本文件(通常是 index.idx)并逐行处理,每行(非注释行)生成一个或多个索引项。
  2. 读取所有行会构建一个 要索引的术语 列表。其中一些可能是直接在脚本文件中定义的术语(由您定义),另一些可能是通过扫描 !scan-path 指令指定的 C++ 头文件和源文件找到的术语。
  3. 一旦 要索引的术语 的完整列表完成,它将加载 Docbook XML 文件。(如果这来自 Quickbook/Doxygen/Boostbook/Docbook,那么这是转换为 Docbook 格式后的完整文档)。
  4. AutoIndex 构建 Docbook XML 的内部 文档对象模型 (DOM)。然后扫描此内部表示,查找 要索引的术语 的出现。此扫描在 XML 段落级别(或等效的同级元素,如表格或代码块)进行 - 因此段落内的所有 XML 编码都将被展平为纯文本。
    这种展平意味着用于搜索 要索引的术语 的正则表达式可以找到完全包含在段落(或代码块等)中的任何内容。
  5. 对于找到的每个术语,然后将一个 indexterm Docbook 元素插入到 文档对象模型 (DOM) 中(前提是内部索引生成已关闭),
  6. 此外,AutoIndex 的内部索引表示也会更新。
  7. 一旦整个 XML 文档被索引,那么,如果 AutoIndex 被指示自行生成索引,它将创建必要的 XML 并将其插入到 文档对象模型 (DOM) 中。
  8. 最后,整个 文档对象模型 (DOM) 被写出为新的 Docbook XML 文件,并且通过 XSL 样式表(使用 xsltproc)继续进行正常处理,以实际构建最终的人类可读文档。

PrevUpHomeNext