PostgreSQL7.0手册-附录-文档
减小字体
增大字体附录 DG2. 文档
内容
文档地图
文档项目计划
文档源文件
制作文档
手册页
v7.0 文档硬拷贝生成
工具集
可选工具集
文档的目的是使 Postgres 易于学习、使用和开发．文档集应该描述 Postgres 系统、语言和接口．文档应该能够回答通常的问题并且让用户能够找到这些答案而无须寻求邮件列表的支持．
文档地图
Postgres 有四种主要的文档格式：
用于安装前信息的纯文本格式．
HTML，用于在线浏览和参考．
硬拷贝（Postscript 或 PDF），用于深入了解和参考．
man pages（手册页），用于快速参考．
表 DG2-1. Postgres 文档内容
文件 描述
./COPYRIGHT 版权声明
./INSTALL 安装指导（从 sgml->rtf->text 来的文本）
./README 介绍性信息
./register.txt 制作过程中的注册信息
./doc/bug.template 臭虫报告模版
./doc/postgres.tar.gz 集成的文档（HTML）
./doc/programmer.ps.gz 程序员手册（Postscript）
./doc/programmer.tar.gz 程序员手册（HTML）
./doc/reference.ps.gz 参考手册（Postscript）
./doc/reference.tar.gz 参考手册（HTML）
./doc/tutorial.ps.gz 介绍（Postscript）
./doc/tutorial.tar.gz 介绍（HTML）
./doc/user.ps.gz 用户手册（Postscript）
./doc/user.tar.gz 用户手册（HTML）
有用于安装的手册页，同样在 Postgres 的源代码树里还有大量的纯文本的 README 类型文件．
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
文档项目计划
打包的文档可以同时获得 HTML 和 Postscript 格式的．这些可以作为标准的 Postgres 安装的一部分获得．我们在这里讨论对文档源文件的加工和生成文档包的问题．
文档源文件是用 SGML 标记纯文本文件写成的。 DocBookSGML 的目的是允许作者声明一个技术文档的内容和结构（利用 DocBookDTD），并且由文档的风格决定其内容最后是如何呈现为最终形式（例如．使用 Norm Walsh 的组件风格表（Modular Style Sheets））．
参阅 DocBook 的介绍 获取一些关于 DocBook 特性的很好的"快速入门读物"．DocBook 元素 提供了一个 DocBook 特性的很好的交叉参考．
这份文档集是使用好几种工具写成的，包括 James Clark 的 jade 和 Norm Walsh 的 组件 DocBook 风格表。
目前，硬拷贝是把从 jade 输出获得的 富文本格式 （Rich Text Format）（RTF）输入到 ApplixWare 做一些微小的修改然后输出成 Postscript 文件．
TeX 是 jade 支持的输出格式之一，但是目前因为几个原因没有使用，包括在提交之前不能做微小的格式修改以及通常在TeX 风格表里面对表格的支持不够．
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
文档源文件
文档源文件包括纯文本文件，手册页和 html．不过，大多数新的 Postgres 文档将用标准的一般性标记语言（Standard Generalized Markup Language）（SGML）DocBook文档类型定义 （Document Type Definition ）（DTD）书写．目前存在的许多文档都已经或将要被转换成 SGML．
SGML 的目的是允许一个作者声明一份文档的结构和内容（例如，使用 DocBookDTD），并且由文档风格定义内容是如何呈现为最后的形式（例如，使用 Norm Walsh 的风格表（stylesheets））．
文档是从几个不同的源收集来的．在我们把现有文档整合组装成一个连贯的文档集时，原先的文档就过时了并且将被从版本中删除．但是，这些动作不会立即发生，并且不会对所有文档同时产生作用．为简化翻译工作，以及为了给开发人员和作者提供帮助，我们定义了翻译过程图．
文档结构
目前有五套用 DodBook 书写的独立的文档．每个文档都有一个源文档容器，该容器定义 DocBook 环境和其他文档源文件．这些基本的源文件放在 doc/src/sgml/，与许多文档使用的其他源文件放在一起．主要的源文件是：
postgres.sgml
这是一个集成的文档，包括作为部件的所有其他文档．生成的输出是 HTML 格式，因为浏览器的界面把在各个文档中跳转简化成简单的敲击．可以同时得到其他文档的 HTML 和硬考贝。
tutorial.sgml
介绍教程和例子．不包括编程的话题，而且是试图帮助那些不熟悉 SQL 的读者．这是"启蒙"文档．
user.sgml
用户手册．包括数据类型和用户级接口的信息．这是放关于"为什么"的信息的地方．
reference.sgml
参考手册．包括 Postgres SQL 语法．这是放关于"怎么做"的信息的地方．
programming.sgml
程序员手册．包括 Postgres 扩展性和编程接口的信息．
admin.sgml
管理员手册．包括安装和发布信息．
风格和传统
DocBook 有着丰富的标记和构件，并且让人惊奇的是其中有很大一部分很显然对格式良好的文档很有帮助．Postgres 的文档集只是最近才采纳了 SGML，并且在不远的将来，有一部分章节将被选择出来并且作为 DocBook 应用的样例原形进行维护．同样在下面将包括一个简短的DocBook 标记的概要．
SGML 写作工具
目前的 Postgres 文档集是用纯文本编辑器（或者说 emacs/psgml；见下文）用 SGML 对其内容进行标记写成的．
SGML 和 DocBook 没有受到过多的开放源码写作工具的影响．最常用的工具集是带有 psgml 扩展特性的 emacs/xemacs 编辑包．在一些系统上（例如．RedHat Linux）这些工具在典型的完全安装时是一并安装的．
emacs/psgml
emacs（以及 xemacs）有一个 SGML主模式（major mode）。如果正确的做了配置，它将允许你使用emacs 插入标签和检查标记连贯性。
把下面这几行放到你的 ~/.emacs 环境文件里（根据你的系统调整路径名）：
; ********** for SGML mode (psgml)
(setq sgml-catalog-files "/usr/lib/sgml/CATALOG")
(setq sgml-local-catalogs "/usr/lib/sgml/CATALOG")
(auto
内容
文档地图
文档项目计划
文档源文件
制作文档
手册页
v7.0 文档硬拷贝生成
工具集
可选工具集
文档的目的是使 Postgres 易于学习、使用和开发．文档集应该描述 Postgres 系统、语言和接口．文档应该能够回答通常的问题并且让用户能够找到这些答案而无须寻求邮件列表的支持．
文档地图
Postgres 有四种主要的文档格式：
用于安装前信息的纯文本格式．
HTML，用于在线浏览和参考．
硬拷贝（Postscript 或 PDF），用于深入了解和参考．
man pages（手册页），用于快速参考．
表 DG2-1. Postgres 文档内容
文件 描述
./COPYRIGHT 版权声明
./INSTALL 安装指导（从 sgml->rtf->text 来的文本）
./README 介绍性信息
./register.txt 制作过程中的注册信息
./doc/bug.template 臭虫报告模版
./doc/postgres.tar.gz 集成的文档（HTML）
./doc/programmer.ps.gz 程序员手册（Postscript）
./doc/programmer.tar.gz 程序员手册（HTML）
./doc/reference.ps.gz 参考手册（Postscript）
./doc/reference.tar.gz 参考手册（HTML）
./doc/tutorial.ps.gz 介绍（Postscript）
./doc/tutorial.tar.gz 介绍（HTML）
./doc/user.ps.gz 用户手册（Postscript）
./doc/user.tar.gz 用户手册（HTML）
有用于安装的手册页，同样在 Postgres 的源代码树里还有大量的纯文本的 README 类型文件．
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
文档项目计划
打包的文档可以同时获得 HTML 和 Postscript 格式的．这些可以作为标准的 Postgres 安装的一部分获得．我们在这里讨论对文档源文件的加工和生成文档包的问题．
文档源文件是用 SGML 标记纯文本文件写成的。 DocBookSGML 的目的是允许作者声明一个技术文档的内容和结构（利用 DocBookDTD），并且由文档的风格决定其内容最后是如何呈现为最终形式（例如．使用 Norm Walsh 的组件风格表（Modular Style Sheets））．
参阅 DocBook 的介绍 获取一些关于 DocBook 特性的很好的"快速入门读物"．DocBook 元素 提供了一个 DocBook 特性的很好的交叉参考．
这份文档集是使用好几种工具写成的，包括 James Clark 的 jade 和 Norm Walsh 的 组件 DocBook 风格表。
目前，硬拷贝是把从 jade 输出获得的 富文本格式 （Rich Text Format）（RTF）输入到 ApplixWare 做一些微小的修改然后输出成 Postscript 文件．
TeX 是 jade 支持的输出格式之一，但是目前因为几个原因没有使用，包括在提交之前不能做微小的格式修改以及通常在TeX 风格表里面对表格的支持不够．
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
文档源文件
文档源文件包括纯文本文件，手册页和 html．不过，大多数新的 Postgres 文档将用标准的一般性标记语言（Standard Generalized Markup Language）（SGML）DocBook文档类型定义 （Document Type Definition ）（DTD）书写．目前存在的许多文档都已经或将要被转换成 SGML．
SGML 的目的是允许一个作者声明一份文档的结构和内容（例如，使用 DocBookDTD），并且由文档风格定义内容是如何呈现为最后的形式（例如，使用 Norm Walsh 的风格表（stylesheets））．
文档是从几个不同的源收集来的．在我们把现有文档整合组装成一个连贯的文档集时，原先的文档就过时了并且将被从版本中删除．但是，这些动作不会立即发生，并且不会对所有文档同时产生作用．为简化翻译工作，以及为了给开发人员和作者提供帮助，我们定义了翻译过程图．
文档结构
目前有五套用 DodBook 书写的独立的文档．每个文档都有一个源文档容器，该容器定义 DocBook 环境和其他文档源文件．这些基本的源文件放在 doc/src/sgml/，与许多文档使用的其他源文件放在一起．主要的源文件是：
postgres.sgml
这是一个集成的文档，包括作为部件的所有其他文档．生成的输出是 HTML 格式，因为浏览器的界面把在各个文档中跳转简化成简单的敲击．可以同时得到其他文档的 HTML 和硬考贝。
tutorial.sgml
介绍教程和例子．不包括编程的话题，而且是试图帮助那些不熟悉 SQL 的读者．这是"启蒙"文档．
user.sgml
用户手册．包括数据类型和用户级接口的信息．这是放关于"为什么"的信息的地方．
reference.sgml
参考手册．包括 Postgres SQL 语法．这是放关于"怎么做"的信息的地方．
programming.sgml
程序员手册．包括 Postgres 扩展性和编程接口的信息．
admin.sgml
管理员手册．包括安装和发布信息．
风格和传统
DocBook 有着丰富的标记和构件，并且让人惊奇的是其中有很大一部分很显然对格式良好的文档很有帮助．Postgres 的文档集只是最近才采纳了 SGML，并且在不远的将来，有一部分章节将被选择出来并且作为 DocBook 应用的样例原形进行维护．同样在下面将包括一个简短的DocBook 标记的概要．
SGML 写作工具
目前的 Postgres 文档集是用纯文本编辑器（或者说 emacs/psgml；见下文）用 SGML 对其内容进行标记写成的．
SGML 和 DocBook 没有受到过多的开放源码写作工具的影响．最常用的工具集是带有 psgml 扩展特性的 emacs/xemacs 编辑包．在一些系统上（例如．RedHat Linux）这些工具在典型的完全安装时是一并安装的．
emacs/psgml
emacs（以及 xemacs）有一个 SGML主模式（major mode）。如果正确的做了配置，它将允许你使用emacs 插入标签和检查标记连贯性。
把下面这几行放到你的 ~/.emacs 环境文件里（根据你的系统调整路径名）：
; ********** for SGML mode (psgml)
(setq sgml-catalog-files "/usr/lib/sgml/CATALOG")
(setq sgml-local-catalogs "/usr/lib/sgml/CATALOG")
(auto
Tags：PostgreSQL,手册,附录,文档
