文書化プロジェクト

Packaged documentation is available in both HTML and Postscript formats. These are available as part of the standard Postgres installation. We discuss here working with the documentation sources and generating documentation packages.

パッケージとしてまとめられた形の文書は、HTMLPostscript の 2 つの形式が利用できます。 標準に従って Postgres をインストールする と、その一部として入手できます。ここで文書化用ソースに対する作業と 文書パッケージの生成について説明します。

The documentation sources are written using SGML markup of plain text files. The purpose of DocBook SGML is to allow an author to specify the structure and content of a technical document (using the DocBook DTD), and to have a document style define how that content is rendered into a final form (e.g. using Norm Walsh's Modular Style Sheets).

文書化用ソースは SGML マークアップを使用した平文 テキストファイルとして作成されています。 DocBook SGML の目的は、 著者が技術文書の構造と内容を( DocBook DTD を使って)指定できるようにすることと、その内 容を最終的な形式にどう変換するのかを定義する(例えば、Norm Walsh 氏 の Modular Style Sheetsといった )文書ス タイルを持つことができるようにすることです。

See Introduction to DocBook for a nice "quickstart" summary of DocBook features. DocBook Elements provides a powerful cross-reference for features of DocBook.

DocBook機能の "quickstart" としてうまくまとまっている Introduction to DocBook を見て下さい。 DocBook Elements は、強力な DocBook 機能のクロスレファレ ンスを提供します。

This documentation set is constructed using several tools, including James Clark's jade and Norm Walsh's Modular DocBook Stylesheets.

文書群は、James Clark 氏の jade や Norm Walsh 氏の Modular DocBook Stylesheets. などの様々なツールを使って作成されます。

Currently, hardcopy is produced by importing Rich Text Format (RTF) output from jade into ApplixWare for minor formatting fixups, then exporting as a Postscript file.

今のところ、jade の出力である リッチテキスト形式RTF )を ApplixWare にインポートして細かなフォーマットの修正し、その後、ポストスクリプ トファイルとしてエキスポートすることで印刷物を作成しています。

TeX is a supported format for jade output, but is not used at this time for several reasons, including the inability to make minor format fixes before committing to hardcopy and generally inadequate table support in the TeX stylesheets.

TeXjade の出力形式としてサポートされていま すが、印刷物化する前の細かなフォーマットの修正ができないこと、 TeX スタイルシートでの表のサポートが一般 的に不十分であることなどのいくつかの理由のため現時点では使用されて いません。