DocBook XML 是一种用于创建文档的基于 XML 的文档类型。
DocBook 和 PostgreSQL
自 6.3 版本(提交 c8cfb0ce)起,PostgreSQL 就提供了 DocBook 格式的文档。多年来,这些文档一直以 SGML 格式维护,但在 PostgreSQL 11(提交 3c49c6fa)中被转换为 XML,尽管为了保持连续性,文件名仍然保留了 .sgml 扩展名。这一更改极大地简化了文档的构建过程。
源代码
文档源文件包含在 doc/src/sgml/ 目录中。
构建文档
在 安装了必需的工具链 的情况下,在已配置的源树中构建 HTML 文档只需在 doc/ 目录下执行 make 命令即可。在配置合理的机器上,构建 HTML 文件应该不到一分钟。
要将文档生成为 PDF 文件,请从 doc/src/sgml/ 目录执行以下命令之一:
make postgres-A4.pdf
或者,对于非标准的美国信函格式:
make postgres-US.pdf
有用链接
- DocBook.org
- DocBook - 维基百科文章
