Appendix DG2. 文档

Table of Contents
DG2.1. DocBook
DG2.2. 工具集
DG2.3. 制作文档
DG2.4. 文档写作

Postgres 有四种主要的文档格式:

另外,在 PostgreSQL 源码树里面还有许多 README 风格的文件,它们记录了许多与实现有关的东西的文档.

文档组织成了几本“书(book)”:

上面五本书都有 HTML 和 Postscript 格式的. 参考手册 包含参考手册的内容,同时也是 手册页的内容.

HTML 文档和手册页(man pages)是标准版本的 一部分并且缺省时安装.Postscript 格式的文档可以独立地下载.

DG2.1. DocBook

文档源文件是用 DocBook 写的, 它是一种标记语言,类似 HTML. 这两种语言都是 Standard Generalized Markup LanguageSGML, (标准通用标记语言)的应用, 它实际上是描述另外一种语言的语言.也就是说,术语上 DocBook 和 SGML 都可以用,而技术上是不能互换的.

DocBook 允许作者不用考虑表现细节 地描述一份技术文档的结构和内容.一份文档风格定义该内容 如何呈现为几种最终形式之一.DocBook 是由 OASIS 组维护的. DocBook 官方站 有很好的介绍和参考手册以及一整本 O'Reilly 的书可供你在线阅读. FreeBSD 文档计划也使用 DocBook 并且有一些很好的 信息,包括一些很值得考虑的风格向导.