文書化用ソース

文書化用ソースには、平文のテキストファイル、マニュアルページ、HTML があります。しかし、最新の Postgres の文 書化は、 Standard Generalized Markup LanguageSGML DocBook Document Type Definition (DTD) を使用して記述されています。既存の文書の多くは SGML に変換済み、もしくは変更される予定です。

SGML の目的は、著者が文書の構造と内容を(例えば、 DocBook DTD を使って) 指定できることと、どう内容を(例えば Norm Walsh 氏のスタイルシート を使って)最終形態に変換するかを定義した文書スタイルを持つことがで きることです。

文書は複数のソースを集めて作られます。既存の文書を理路整然とした文書 群に統合、同化する時、古いバージョンのものは利用されなくなり、配布物 内から削除されます。しかし、これは即座に行なわれませんし、全文書に対 して同時に行なうこともありません。移行を簡単にするために、そして、ガ イドの開発者や作者を補助するために、移行のロードマップを定義していま す。

バージョン 6.5 用の文書化計画をここに示します。

文書の構造

現在 DocBook 形式で書かれた、5 つの文書があります。各文書は DocBook 環境と他の文書化用ソースファイルを定義したソース文書コン テナを持ちます。これら主要なソースファイルは、文書化に使用される 他の多くのソースファイルと一緒に、 doc/src/sgml/ にあります。主要なソースファイ ルとは次のものです。

postgres.sgml

これは統合化された文書で、構成部品として全ての文書を含んでいます。 ブラウザインタフェースからクリックするだけで文書全体を簡単に移動 できるように、出力は HTML 形式で作成されていま す。この他の文書は HTML 形式及び印刷物形式のど ちらでも入手できます。

tutorial.sgml

例をもった、入門用チュートリアル。プログラミングに関する話題はな く、SQL をあまり知らない読者を助けることを目的 としています。これは「さぁ始めましょう」的な文書です。

user.sgml

ユーザガイド。データ型やユーザレベルのインタフェースについての情 報を持ちます。ここは「どうして」という疑問に応えるための情報を置 く場所です

reference.sgml

レファレンスマニュアル。Postgres SQL 構文の情報を持ちます。ここは「どのように」と いう疑問に応えるための情報を置く場所です。

programming.sgml

プログラマガイド。Postgres の拡張機能 やプログラミングインタフェースに関する情報を持ちます。

admin.sgml

アドミニストレータガイド。インストール方法やリリースノートを含 みます。

文書化用ファイル

Table DG2-2. Postgres 文書化用ソース

ファイル状態 
./doc/src/graphics/catalogs.gif 出力用ファイル 
./doc/src/graphics/clientserver.ag ソースファイル。CGMへ変換する。 
./doc/src/graphics/clientserver.gif 出力用ファイル 
./doc/src/graphics/connections.ag ソースファイル。CGMへ変換する。 
./doc/src/graphics/connections.gif 出力用ファイル 
./doc/src/graphics/layout.ag ソースファイル。CGMへ変換する。 
./doc/src/graphics/layout.gif 出力用ファイル。 
./doc/src/sgml/about.sgml 新規文書。  
./doc/src/sgml/admin.sgml アドミニストレータガイドのコンテナ 
./doc/src/sgml/advanced.sgml 変換済。 
./doc/src/sgml/arch-dev.sgml 変換済。 
./doc/src/sgml/arch-pg.sgml 変換済。 
./doc/src/sgml/arch.sgml 変換済。 
./doc/src/sgml/array.sgml 変換済。 
./doc/src/sgml/biblio.sgml 新規文書。 
./doc/src/sgml/bki.sgml bki.5 から変換済。 
./doc/src/sgml/compiler.sgml 新規文書 
./doc/src/sgml/config.sgml 新規文書 
./doc/src/sgml/contacts.sgml 文書の寄稿者? 未使用。完成させるか削除させるか 
./doc/src/sgml/datatype.sgml 新規文書 
./doc/src/sgml/dfunc.sgml 変換済。 
./doc/src/sgml/docguide.sgml 文書化情報。 新規文書。 
./doc/src/sgml/ecpg.sgml ecpg 埋め込み SQL プレコンパイラに関する文書。 
./doc/src/sgml/environ.sgml 変換済。 
./doc/src/sgml/extend.sgml 変換済。 
./doc/src/sgml/func-ref.sgml 変換済。 
./doc/src/sgml/func.sgml 変換済。 
./doc/src/sgml/geqo.sgml GEQO 遺伝的最適化に関する文書。 
./doc/src/sgml/gist.sgml メーリングリストから引用した新規文書。 
./doc/src/sgml/history.sgml 新規文書。 
./doc/src/sgml/indices.sgml 新規文書。 
./doc/src/sgml/info.sgml 新規文書。 
./doc/src/sgml/inherit.sgml 変換済。 
./doc/src/sgml/install.sgml インストール手順。 
./doc/src/sgml/intro-ag.sgml アドミニストレータガイドの序文。変換済。 
./doc/src/sgml/intro-pg.sgml プログラマガイドの序文。 変換済。 
./doc/src/sgml/intro.sgml ユーザガイドの序文。 
./doc/src/sgml/jdbc.sgml Peter Mount 氏による新規文書。 
./doc/src/sgml/keys.sgml 新規文書。 
./doc/src/sgml/legal.sgml 著作権など。序文用。 
./doc/src/sgml/libpgtcl.sgml 変換済。 
./doc/src/sgml/libpq++.sgml C++ ライブラリ。変換済。 
./doc/src/sgml/libpq.sgml C ライブラリ。 
./doc/src/sgml/lobj.sgml ラージオブジェクト。 
./doc/src/sgml/manage.sgml 変換済。 
./doc/src/sgml/notation.sgml 序文用の文書内記述方法。 
./doc/src/sgml/odbc.sgml ODBC ドライバ。 
./doc/src/sgml/oper.sgml 変換済。 
./doc/src/sgml/page.sgml ディスク上での保存スキーマ。 
./doc/src/sgml/pg_options.sgml バックエンドの設定。 
./doc/src/sgml/pgaccess.sgml 変換済。 
./doc/src/sgml/ports.sgml サポートされた/サポートされていないプラットホーム。 
./doc/src/sgml/postgres.sgml 全文書用のコンテナ。html 出力に最適。 
./doc/src/sgml/programmer.sgml プログラマガイド。 
./doc/src/sgml/protocol.sgml 変換済。 
./doc/src/sgml/psql.sgml 変換済。 
./doc/src/sgml/query-ug.sgml 変換済。 
./doc/src/sgml/query.sgml 変換済。 
./doc/src/sgml/recovery.sgml データベースの復旧。 
./doc/src/sgml/reference.sgml 変換済。 
./doc/src/sgml/regress.sgml Regression テスト。 
./doc/src/sgml/release.sgml 変換済。 
./doc/src/sgml/rules.sgml ルールシステム。 
./doc/src/sgml/runtime.sgml 実行時環境。バージョン 6.4 用の新規文書。 
./doc/src/sgml/security.sgml サーバのセキュリティ。 
./doc/src/sgml/signals.sgml バックエンド用のシステムシグナル。 
./doc/src/sgml/spi.sgml 変換済。元文書は削除された。 
./doc/src/sgml/start-ag.sgml 変換済。 
./doc/src/sgml/start.sgml 変換済。 
./doc/src/sgml/storage.sgml 変換済。 
./doc/src/sgml/syntax.sgml SQL 構文。 UG 内。  
./doc/src/sgml/trigger.sgml 変換済。 
./doc/src/sgml/tutorial.sgml チュートリアル用コンテナ  
./doc/src/sgml/typeconv.sgml データ型の変換。バージョン 6.4 用の新規文書。UG 内。  
./doc/src/sgml/user.sgml ユーザガイド。 
./doc/src/sgml/xaggr.sgml 変換済。 
./doc/src/sgml/xfunc.sgml 変換済。 
./doc/src/sgml/xindex.sgml 変換済。 
./doc/src/sgml/xoper.sgml 変換済。 
./doc/src/sgml/xplang.sgml プログラミング言語。バージョン 6.4 用の新規文書。 
./doc/src/sgml/xtypes.sgml 変換済。 
./doc/src/sgml/y2k.sgml Y2K 宣言。バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/abort.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/allfiles.sgml ref/ 内のファイルの一覧。(内部用)  
./doc/src/sgml/ref/alter_table.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/alter_user.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/begin.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/close.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/cluster.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/commands.sgml コマンド一覧。 (内部用)  
./doc/src/sgml/ref/commit.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/copy.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_aggregate.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_database.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_function.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_index.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_language.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_operator.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_rule.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_sequence.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_table.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/create_trigger.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/create_type.sgml バージョン 6.4 用の新規文書。  
./doc/src/sgml/ref/create_user.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/create_view.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/createdb.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/createuser.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/declare.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/delete.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/destroydb.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/destroyuser.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_aggregate.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_database.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_function.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_index.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_language.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_operator.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_rule.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_sequence.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_table.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_trigger.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_type.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_user.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/drop_view.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/explain.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/fetch.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/grant.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/initdb.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/initlocation.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/insert.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/listen.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/load.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/lock.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/move.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/notify.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/pg_dump.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/pg_dumpall.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/psql-ref.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/reset.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/revoke.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/rollback.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/select.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/set.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/show.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/update.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/vacuum.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/unlisten.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/vacuumdb.sgml バージョン 6.4 用の新規文書。 
./doc/src/sgml/ref/pg_upgrade.sgml バージョン 6.4 用の新規文書。 

文書の変換

Table DG2-3. Postgres 文書化用ソース

ファイル状態 
./HISTORY 残骸。release.sgmlに変更された。 
./README 未変換。 
./INSTALL 残骸。install.sgmlに変更された。 
./contrib/README 未変換。 
./contrib/apache_logging/README 未変換。 
./contrib/array/array_iterator.doc 未変換。 
./contrib/datetime/datetime_functions.doc 未変換。 
./contrib/earthdistance/README 未変換。 
./contrib/int8/README 未変換。 
./contrib/ip_and_mac/README 未変換。 
./contrib/lo/README 未変換。 
./contrib/mSQL-interface/README 未変換。 
./contrib/noupdate/noup.example 未変換。 
./contrib/pginterface/README 未変換。 
./contrib/sequence/set_sequence.sql.in 未変換。 
./contrib/soundex/soundex.sql.in 未変換。 
./contrib/spi/README 未変換。 
./contrib/spi/autoinc.example 未変換。 
./contrib/spi/insert_username.example 未変換。 
./contrib/spi/refint.example 未変換。 
./contrib/spi/timetravel.example 未変換。 
./contrib/string/string_io.sql.in 未変換。 
./contrib/unixdate/unixdate.sql 未変換。 
./contrib/userlock/user_locks.doc 未変換。 
./doc/FAQ 未変換。 
./doc/FAQ_DEV 未変換。 
./doc/FAQ_FreeBSD 未変換。 
./doc/FAQ_Irix 未変換。 
./doc/FAQ_Linux 未変換。 
./doc/TODO 未変換。 
./doc/README.GEQO 削除済。geqo.sgmlで更新。 
./doc/README.fsync アドミニストレータガイドに吸収。 
./doc/README.locale アドミニストレータガイドに吸収。 
./doc/README.mb アドミニストレータガイドに吸収。 
./doc/README.mb.jp 未変換。 
./doc/README.support 未変換。 
./doc/TODO.GEQO 削除済。geqo.sgmlで更新。 
./doc/userguide.ps 削除済。(SGMLに変換済) 
./src/DEVELOPERS 未変換。 
./src/backend/access/nbtree/README 未変換。 
./src/backend/catalog/README 未変換。 
./src/backend/libpq/pg_hba.conf.sample 未変換。 
./src/backend/libpq/pg_ident.conf.sample 未変換。 
./src/backend/nodes/README 未変換。 
./src/backend/optimizer/README 未変換。 
./src/backend/optimizer/geqo/pg_geqo.sample 未変換。 
./src/backend/optimizer/plan/README 未変換。 
./src/backend/parser/README 未変換。 
./src/backend/port/dynloader/README.dlfcn.aix 未変換。 
./src/backend/regex/COPYRIGHT 未変換。 
./src/backend/regex/WHATSNEW 未変換。 
./src/backend/regex/re_format.7 未変換。 
./src/backend/regex/regex.3 未変換。 
./src/backend/storage/ipc/README 未変換。 
./src/backend/storage/lmgr/README 未変換。 
./src/backend/storage/smgr/README 未変換。 
./src/bin/pg_dump/README 未変換。 
./src/bin/pgaccess/README.pga 未変換。 
./src/bin/pgaccess/formdemo.sql 未変換。 
./src/bin/pgtclsh/README 未変換。 
./src/data/charset.conf 未変換。 
./src/data/koi-alt.tab 未変換。 
./src/data/koi-iso.tab 未変換。 
./src/data/koi-koi.tab 未変換。 
./src/data/koi-mac.tab 未変換。 
./src/data/koi-win.tab 未変換。 
./src/interfaces/ecpg/ChangeLog 未変換。 
./src/interfaces/ecpg/TODO 未変換。 
./src/interfaces/jdbc/README 未変換。 
./src/interfaces/jdbc/README_6.3 未変換。 
./src/interfaces/jdbc/example/ImageViewer.java 未変換。 
./src/interfaces/jdbc/example/basic.java 未変換。 
./src/interfaces/jdbc/example/blobtest.java 未変換。 
./src/interfaces/jdbc/example/datestyle.java 未変換。 
./src/interfaces/jdbc/example/psql.java 未変換。 
./src/interfaces/libpgtcl/README 未変換。 
./src/interfaces/libpq/README 未変換。 
./src/interfaces/libpq++/README 未変換。 
./src/interfaces/libpq++/examples/testlibpq0.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq1.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq2.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq2.sql 未変換。 
./src/interfaces/libpq++/examples/testlibpq3.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq3.sql 未変換。 
./src/interfaces/libpq++/examples/testlibpq4.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq4.sql 未変換。 
./src/interfaces/libpq++/examples/testlibpq5.cc 未変換。 
./src/interfaces/libpq++/examples/testlibpq5.sql 未変換。 
./src/interfaces/libpq++/examples/testlibpq6.cc 未変換。 
./src/interfaces/libpq++/examples/testlo.cc 未変換。 
./src/interfaces/odbc/license.txt 未変換。 
./src/interfaces/odbc/notice.txt 未変換。 
./src/interfaces/odbc/readme.txt 未変換。 
./src/interfaces/perl5/MANIFEST 未変換。 
./src/interfaces/perl5/Changes 未変換。 
./src/interfaces/perl5/eg/example.newstyle 未変換。 
./src/interfaces/perl5/README 未変換。 
./src/interfaces/python/Announce 未変換。 
./src/interfaces/python/ChangeLog 未変換。 
./src/interfaces/python/README 未変換。 
./src/interfaces/python/tutorial/advanced.py 未変換。 
./src/interfaces/python/tutorial/advanced.pyc 未変換。 
./src/interfaces/python/tutorial/basics.py 未変換。 
./src/interfaces/python/tutorial/func.py 未変換。 
./src/interfaces/python/tutorial/func.pyc 未変換。 
./src/interfaces/python/tutorial/pgtools.py 未変換。 
./src/interfaces/python/tutorial/pgtools.pyc 未変換。 
./src/interfaces/python/tutorial/syscat.py 未変換。 
./src/interfaces/python/tutorial/syscat.pyc 未変換。 
./src/man/README 未変換。 
./src/man/abort.l 未変換。 
./src/man/alter_table.l 未変換。 
./src/man/alter_user.l レファレンスマニュアルとアドミニストレータガイドに分割。 
./src/man/begin.l 未変換。 
./src/man/catalogs.3 カタログの一覧。プログラマーズガイドに移動された? 
./src/man/cleardbdir.1 未変換。 
./src/man/close.l 未変換。 
./src/man/cluster.l 未変換。 
./src/man/commit.l 未変換。 
./src/man/copy.l 未変換。 
./src/man/create_aggregate.l 未変換。 
./src/man/create_database.l 未変換。 
./src/man/create_function.l 未変換。 
./src/man/create_index.l 未変換。 
./src/man/create_language.l 未変換。 
./src/man/create_operator.l 未変換。 
./src/man/create_rule.l 未変換。 
./src/man/create_sequence.l 未変換。 
./src/man/create_table.l 未変換。 
./src/man/create_trigger.l 未変換。 
./src/man/create_type.l 未変換。 
./src/man/create_user.l 未変換。 
./src/man/create_version.l 未変換。 
./src/man/create_view.l 未変換。 
./src/man/createdb.1 未変換。 
./src/man/createuser.1 未変換。 
./src/man/declare.l 未変換。 
./src/man/delete.l 未変換。 
./src/man/destroydb.1 未変換。 
./src/man/destroyuser.1 未変換。 
./src/man/drop.l 未変換。 
./src/man/drop_aggregate.l 未変換。 
./src/man/drop_database.l 未変換。 
./src/man/drop_function.l 未変換。 
./src/man/drop_index.l 未変換。 
./src/man/drop_language.l 未変換。 
./src/man/drop_operator.l 未変換。 
./src/man/drop_rule.l 未変換。 
./src/man/drop_sequence.l 未変換。 
./src/man/drop_table.l 未変換。 
./src/man/drop_trigger.l 未変換。 
./src/man/drop_type.l 未変換。 
./src/man/drop_user.l 未変換。 
./src/man/drop_view.l 未変換。 
./src/man/end.l 未変換。 
./src/man/ecpg.1 簡単なマニュアルページ。保持する。 
./src/man/explain.l 未変換。 
./src/man/fetch.l 未変換。 
./src/man/grant.l 未変換。 
./src/man/initdb.1 未変換。 
./src/man/initlocation.1 未変換。 
./src/man/insert.l 未変換。 
./src/man/ipcclean.1 未変換。 
./src/man/listen.l 未変換。 
./src/man/load.l 未変換。 
./src/man/lock.l 未変換。 
./src/man/move.l 未変換。 
./src/man/notify.l 未変換。 
./src/man/pg_dump.1 アドミニストレータガイドに吸収  
./src/man/pg_dumpall.1 アドミニストレータガイドに吸収  
./src/man/pg_upgrade.1 アドミニストレータガイドに吸収  
./src/man/pg_hba.conf.5 アドミニストレータガイドに吸収  
./src/man/pg_passwd.1 アドミニストレータガイドに吸収  
./src/man/pgintro.1 ユーザガイドに吸収?  
./src/man/postgres.1 ユーザガイド、アドミニストレータガイドに吸収  
./src/man/postmaster.1 ユーザガイド、アドミニストレータガイドに吸収  
./src/man/psql.1 未変換。 
./src/man/reset.l 未変換。 
./src/man/revoke.l 未変換。 
./src/man/rollback.l 未変換。 
./src/man/select.l 未変換。 
./src/man/set.l 未変換。 
./src/man/show.l 未変換。 
./src/man/sql.l 未変換。 
./src/man/update.l 未変換。 
./src/man/vacuum.l 未変換。 
./src/pl/tcl/INSTALL 未変換。 
./src/pl/tcl/modules/README 未変換。 
./src/pl/tcl/license.terms 未変換。 
./src/pl/tcl/test/README 未変換。 
./src/pl/tcl/test/runtest 未変換。 
./src/pl/tcl/test/test.expected 未変換。 
./src/pl/tcl/test/test_mklang.sql 未変換。 
./src/pl/tcl/test/test_queries.sql 未変換。 
./src/pl/tcl/test/test_setup.sql 未変換。 
./src/test/bench/WISC-README 未変換。 
./src/test/locale/README 未変換。 
./src/test/performance/results/PgSQL.970926 未変換。 
./src/test/regress/README 未変換。 
./src/test/suite/README 未変換。 
./src/tools/RELEASE_CHANGES 未変換。 
./src/tools/SQL_keywords 未変換。 
./src/tools/backend/README 未変換。 
./src/tools/backend/flow.fig 未変換。 
./src/tools/backend/flow.jpg 未変換。 
./src/tools/make_keywords.README 未変換。 
./src/tools/entab/entab.man 未変換。 
./src/tools/make_diff/README 未変換。 
./src/tools/mkldexport/README 未変換。 
./src/tools/pgindent/README 未変換。 
./src/tutorial/README 未変換。 
./src/utils/README 未変換。 
./lib/pg_hba.conf.sample 未変換。 
./lib/pg_geqo.sample 未変換。 

スタイルと規定

DocBook は豊富なタグ、構成要素のセットを持ち、 それらの驚くほど大部分は、そのまま、そして言っている意味のままで、良く 整った文書を作成するために有効です。 Postgres 文書群はつい最近 SGML 化され、近い将来、この文書群のいくつかの節は、 DocBook の使用方法の模範となる例として選 ばれ、管理されることになるでしょう。また、 DocBook タグの簡単な要約についてもこの節 に含める予定です。

SGML 記述用ツール

現在の Postgres 文書群は平文用のテキストエディタ (もしくは後述の emacs/psgml )を使用して、SGML DocBook タグによって内容がマークアップされた形で記述されています。

SGMLDocBook では オープンソースの作成ツールが過剰に供給されることを問題としません。 最も一般的なツールセットは psgml 機能拡張を使用した、emacs/xemacs 編集用パッケージです。( RedHat Linux など)システムによっては、こ れらのツールは典型的なフルインストールで提供されます。

emacs/psgml

emacs(及び xemacs )は SGML メジャーモード を持っています。適切に設定され ていれば、emacs を使って、タグの挿入やマー クアップの一貫性チェックを行なうことができます。

以下を ~/.emacs 環境ファイルに記述して下さい。

; ********** for SGML mode (psgml)

(setq sgml-catalog-files "/usr/lib/sgml/CATALOG")
(setq sgml-local-catalogs "/usr/lib/sgml/CATALOG")

(autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t )
SGML を(既存の)auto-mode-alist の定義に設定す るために次のエントリを同ファイルに追加して下さい。
(setq
  auto-mode-alist
  '(("\\.sgml$" . sgml-mode)
   ))
SGML ソースファイルの終りには次のブロックがあ ります。
!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"./reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
--

Postgres 配布物内には分析済 DTD 定義 ファイル reference.ced があります。きっと見 つけることができるでしょう。

emacs/psgml を使う場合、本の一部となる分割 されたファイルを編集する際に適切な DOCTYPE 宣言を挿入しておくことによ り、その作業は快適になります。このソース、例えば「付録」の章で作業を行 なっている場合、次のような行を最初に付けることで、その文書を「付録」と いう DocBook 文書のインスタンスとして指定できます。

!doctype appendix PUBLIC "-//Davenport//DTD DocBook V3.0//EN"
この行は、SGML を解釈する何らかのものが正しく理解でき ることを意味し、私の場合は "nsgmls -s docguide.sgml" を行なってその文書 の検証を行なうことになります。