付録 G. Documentation

目次
G.1. DocBook
G.2. ツールセット
G.3. ドキュメントのビルド
G.4. ドキュメントの起草
G.5. スタイルガイド

PostgreSQL には 4 つの基本的なドキュメントフォーマットがあります。

さらに、PostgreSQL ソースツリー全体にわたりさまざまな 実装に関する問題を記述した平文の README ファイルが数多くあります。

HTML ドキュメントとマニュアルページは標準の配布物の 一部でデフォルトでインストールされます。PDF と Postscript 形式の ドキュメントは別途ダウンロードで入手できます。

G.1. DocBook

ドキュメントソースは見たところ HTML に似た マークアップ言語である DocBook で書かれています。 これらいずれの言語も、もともと他の言語を記述する言語である Standard Generalized Markup LanguageSGML、のアプリケーションです。ここからは、 DocBook と SGML 両方の用語が使用されますが技術的に相互の互換性はありません。

DocBook で執筆する時、最終的な見栄えが どうなるかに気を使わず技術ドキュメントの構造と内容を指定できます。 あるドキュメントスタイルによりいくつか存在する最終形式のひとつに 内容をどのように翻訳するかが定義されます。 DocBook は OASIS グループにより メンテナンスされています。公式 DocBook サイトには 役にたつ入門用と参照用のドキュメント、そして O'Reilly 社の本の完全版を オンラインで読めます。FreeBSD ドキュメント プロジェクトでも同様に DocBook を使用していて注目すべき数多くの スタイルに関する指針を含め、役立つ情報があります。

アダルトレンタルサーバー