↑↓ 选择 ↵ 打开 ⌫ 改范围 完整检索页

pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。

不受支持的版本: 6.4 / 6.3
历史版本PostgreSQL 6.4 已于 2003 年 10 月结束社区维护,本页译文保留供仍在使用旧版本的读者参考。新系统请看当前版本手册首页。

A.3. 文档项目

打包的文档有 HTML 和 Postscript 两种格式。它们作为标准 Postgres 安装的一部分提供。我们在这里 讨论如何使用文档源码以及如何生成文档 包。

注意

这是三年来 Postgres 新文档的 第一个发行版。内容和环境都还在变动和 演化之中。

SGML 的目的是让作者能够 指定文档的结构和内容(例如使用 DocBook DTD), 并由文档样式定义这些内容如何被渲染成 最终形式(例如使用 Norm Walsh 的样式表)。

参阅 Introduction to DocBook,那里有一份不错的 DocBook 特性 “快速入门”摘要。 DocBook Elements 为 DocBook 的特性提供了强大的交叉参考。

本文档集使用若干工具构建,包括 James Clark 的 jade 和 Norm Walsh 的 Modular DocBook Stylesheets。

目前,硬拷贝是通过把 jade 输出的富文本格式(RTF)导入 ApplixWare 做少量格式修正,然后 导出为 Postscript 文件来生成的。

TeX 是 jade 输出的一种受支持格式,但当时 未被使用,原因有几点,包括在提交硬拷贝之前无法做小的格式 修正,以及 TeX 样式表对表格的支持普遍不足。

A.3.1. 样式与约定

DocBook 有一组丰富的标签和 构造,其中直接而明显地适用于良构文档的百分比 出人意料地高。Postgres 文档集最近才改写为 SGML,不久 将来会从文档集中选出若干节,作为 DocBook 用法的示范性示例加以 维护。此外,下面还会给出 DocBook 标签的简短摘要。

A.3.2. 编写工具

当前的 Postgres 文档集是使用 纯文本编辑器(或 emacs/psgml,见下文)编写的,内容用 SGML 标记。

SGML 和 DocBook 的开源编写工具 并不多。最常见的工具集是 带 psgml 功能扩展的 emacs/xemacs 编辑软件包。 在某些系统(例如 RedHat Linux)上,典型的完整安装会包含这些工具。

A.3.2.1. emacs/psgml

使用 emacs/psgml 时,处理这些 分别保存书籍各部分的文件,有一种方便的方式:在编辑时 插入适当的 DOCTYPE 声明。例如,当前这个源码 文件是一章附录,因此可以将它指定为 DocBook 文档的 “appendix”实例,把第一行写成这样:

!doctype appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN"

这意味着任何读取 SGML 的东西都能正确处理它, 而且我可以用 “nsgmls -s docguide.sgml” 验证该文档。

提交更正

译文有误、术语不当或页面显示问题,请到译文仓库 pgsty/pgdoc 报告译文问题。 英文原文本身的问题,请在当前版本的对应页面向上游反馈;上游不再修订已结束维护的版本。