Appendix DG2. ドキュメント

Table of Contents
DG2.1. DocBook
DG2.2. ツールセット
DG2.3. ドキュメント作成
DG2.4. ドキュメントの作成

PostgreSQLは4つの主要なドキュメントフォーマット があります。

加えて、PostgreSQLソースツリー全体を通して、 様々な実装の問題に関するプレインテキストのREADMEファイルも存在しています。

ドキュメントは、様々の混乱する名前を持ついくつかの"本" に分かれています。

これらの5つの本全ては、HTMLとポストスクリプトで見ることができます。ユーザガイド はマニュアルページとして参照されるものも含んでいます。

HTMLドキュメントとマニュアルページは標準配布の一部であり、デフォルトで インストールされます。ポストスクリプトフォーマットのドキュメントは別にダウンロード することができます。

DG2.1. DocBook

ドキュメントのソースはDocBookで書かれています。 DocBookは、表面的にはHTMLに似た マークアップ言語です。どちらの言語も、本来他の言語を記述するための言語 であるStandard Generalized Markup Language, SGMLのアプリケーション です。ここからは、DocBooksとSGMLの両方が使われていますが、技術的に これらは互換性はありません。

DocBookを書く人は、表示の細部について気にせずに技術的な ドキュメントの構造や内容を指定することができます。ドキュメントのスタイルは、 その中身がどのようにいくつかの最終形になるかを定義します。DocBookはOASISグループによって保持されています。 公式DocBookサイトでは 役に立つ入門、実践のドキュメントとオライリーの本の完全版をウェブ上で読むことが できます。FreeBSD ドキュメントプロジェクトもやはりDocBookを使っていて、役に立ちそうな スタイルへの誘導が含まれています。(訳注:これらのサイトは英語のサイトです。)