Appendix B. 文档

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

PostgreSQL 有四种主要的文档格式：

纯文本，用于安装前信息的纯文本格式．
HTML ，用于在线浏览和参考．
Postscript，用于打印．
man pages（手册页），用于快速参考．

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

文档组织成了几本 "书（book）" ：

教程：给新用户的介绍性材料
用户手册 ：SQL 实现的文档
参考手册 : SQL 命令和程序的参考手册
管理员手册 ∶安装和服务器管理和维护
程序员手册 ：编写客户应用和服务器扩展
开发人员手册 ：进行 PostgreSQL 开发的混合信息

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

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

B.1. DocBook

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

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