Apache FreeMarker Docgen 技术文档

本文档将详细介绍如何安装、使用 Apache FreeMarker Docgen 项目，并说明其 API 的使用方式。

1. 安装指南

环境要求

在使用 Apache FreeMarker Docgen 前，确保已安装以下工具：

• JDK 8 (已测试版本：Oracle 1.8.0_212)
• Apache Maven (已测试版本：3.6.1)
• Node.js (已测试版本：12.18.2，14.x.x 可能不兼容)

安装步骤

1. 确保 Node.js 的 npm 工具已在系统路径中。

2. 在项目根目录 (freemarker-docgen) 下执行以下 Maven 命令：

   mvn install

2. 使用说明

使用示例

• 查看以下项目以获取使用示例：

  • freemarker-site 项目
  • FreeMarker Manual 源代码
  • 此项目中的 legacy-tests

• 使用 XXE 编辑 DocBook，需安装 xxe-addon。

运行 Docgen

若在 IDE 中开发/调试 Docgen，可以创建一个运行配置，主类为 org.freemarker.docgen.cli.Main，并包含以下命令行参数（将 <FREEMARKER_PROJECT_DIR> 替换为实际目录）：

`<FREEMARKER_PROJECT_DIR>\src\manual`
`<FREEMARKER_PROJECT_DIR>\build\manual`
`offline=true`

若要固定最后修改时间以便于比较不同运行结果，可以使用以下 Java 参数：

`-Ddocgen.generationTime=2020-07-15T17:00Z`

3. 项目 API 使用文档

Apache FreeMarker Docgen 的 API 使用细节在官方文档中并未明确列出，建议直接查看项目源码和示例来了解如何调用和使用。

4. 项目安装方式

请遵循上述“安装指南”中的步骤进行项目安装。

---

本文档已概述了 Apache FreeMarker Docgen 的安装和使用方法，帮助用户更好地理解和运用该项目。