A.2. 文档源码
文档源码包括纯文本文件、手册页和 html。不过,Postgres 的新文档大多将使用标准通用标记语言(SGML) DocBook 文档类型定义(DTD)编写。现有文档的大部分已经或将被转换为 SGML。
SGML 的目的是让作者能够指定文档的结构和内容(例如使用 DocBook DTD),并由文档样式定义这些内容如何被渲染成最终形式(例如使用 Norm Walsh 的样式表)。
文档积累自多个来源。随着我们把现有文档整合成一个连贯的文档集,较旧的版本将逐渐过时,并会从发行包中删除。但是,这不会立即发生,也不会同时发生在所有文档上。为了简化过渡,并帮助引导开发者和作者,我们定义了一份过渡路线图。
下面是 v6.5 的文档计划:
开始为用户指南和管理员指南编译索引信息。
为用户指南编写更多涵盖参考页之外内容的节。这将包括入门信息,以及对典型设计问题的处理方法建议。
把现有手册页中的信息合并到参考页和用户指南中。把手册页压缩成提示性信息,并带上指向主文档集的引用。
把新的 sgml 参考页转换为新的手册页,替换现有的手册页。
为了可移植性,把所有源图形转换为 CGM 格式文件。目前我们大多只有 Applix Graphics 源文件,可以从中生成 .gif 输出。有一幅图只有 .gif 和 .ps 形式,应当重画或删除。
A.2.1. 文档结构
目前有五份用 DocBook 编写的独立文档。每份文档都有一个容器源文档,它定义 DocBook 环境和其他文档源文件。这些主源文件位于
doc/src/sgml/,文档使用的许多其他源文件也在那里。主源文件有:
- postgres.sgml
这是集成文档,把所有其他文档作为部分包含在内。它以 HTML 格式生成输出,因为浏览器界面让你只需点击就能在全部文档之间轻松跳转。其他文档同时提供 HTML 和硬拷贝两种格式。
- tutorial.sgml
入门教程,带示例。不包括编程主题,旨在帮助不熟悉 SQL 的读者。这是“入门”文档。
- user.sgml
用户指南。包括数据类型和用户级接口的信息。这是放置“为什么”类信息的地方。
- reference.sgml
参考手册。包括 Postgres SQL 语法。这是放置“怎么做”类信息的地方。
- programming.sgml
程序员指南。包括 Postgres 可扩展性以及编程接口的信息。
- admin.sgml
管理员指南。包括安装说明和发行说明。