他のバージョンの文書11 | 10 | 9.6 | 9.5 | 9.4 | 9.3 | 9.2 | 9.1 | 9.0 | 8.4 | 8.3 | 8.2 | 8.1 | 8.0 | 7.4 | 7.3 | 7.2

G.3. ドキュメントのビルド

全ての設定が終了したら、doc/src/sgmlディレクトリに移動して以下のコマンドの1つを実行してください (GNU makeを使うのを忘れずに)。

G.3.1. HTML

HTML形式のドキュメントを作成するには次のようにします。

doc/src/sgml$ gmake html

これはデフォルトでの対象物です。

HTMLドキュメントが作成されると、処理の過程で索引項目にリンクする情報が生成されます。 ですから、最後のところに大まかな索引を付けたいと思った場合は、もう一度HTMLドキュメントをビルドする必要があり、希望するところのどんな形式のドキュメントでも再ビルドしてください。

最終の配布物の取り扱いを簡単にするため、HTMLドキュメントを構成するファイルは、tarでアーカイブされインストールの時に解凍されます。 HTML形式のドキュメント一式を作成するには、以下のコマンドを使用します。

cd doc/src
gmake postgres.tar.gz

これらのアーカイブは配布物のdocディレクトリにあり、何もしなくてもgmake installでインストールされます。

G.3.2. マニュアルページ

DocBook refentryページをマニュアルページに対応した*roff形式に変換するには、docbook2manユーティリティを使用します。 manページもHTML形式と同じようにtarアーカイブで配布されています。 マニュアルページの一式を作成するには次のようにします。

cd doc/src
gmake man.tar.gz

結果としてdoc/srcにtarファイルが生成されます。

マニュアルページを生成するには、質の高い変換ユーティリティもしくは手作業の処理が必要になることがあります。 マニュアルページの全ては、配布する前に目で見てチェックする必要があります。

G.3.3. JadeTex からの印刷

JadeTexを使って印刷可能なドキュメントを作成したい時は、以下のコマンドの中から1つを選んでください。

G.3.4. RTFからの印刷

PostgreSQLドキュメントの印刷できるバージョンをRTFに変換した後、ちょっとした修正をOffice Suiteで施すことで作成できます。 特定のOffice Suiteによる機能で、ドキュメントを引き続きPDFのPostscriptに変換できます。 以下にApplixwareを使ってこの手順を示します。

注意: 現バージョンのPostgreSQLドキュメントは、OpenJadeの大きさの限界とそれを超えた部分でのバクを引き起こすようです。 もしRTFバージョンがビルド過程で長時間にわたってハングアップし、かつ出力ファイルのサイズが0のままであるような場合は、この問題に遭遇したことになります (とは言っても、通常のビルドには5分から10分を要しますので、あせって中断しないように注意してください)。

Applixware RTFの手入れ

OpenJadeは本文に対してデフォルトのスタイルシートの特定を省略します。 過去においてはこの原因不明の問題によって、表内容を生成するまで長い過程を必要としました。 しかし、Applixwareに関わっている仲間の助力でこの症状が判明し、しっくり行くようになりました。

  1. RTFバージョンを生成するためには次のように入力します。

    doc/src/sgml$ gmake postgres.rtf

  2. 全てのスタイル(特にデフォルトスタイル)を正しく指定するようにRTFファイルを修正します。 ドキュメントにrefentry節がある場合、前の段落を現在の段落に連結されるフォーマット指示を、現在の段落が次の段落に連結するように置き換えなければなりません。 これらの修正を行ってくれるfixrtfユーティリティはdoc/src/sgmlにあります。

    doc/src/sgml$ ./fixrtf --refentry postgres.rtf

    このスクリプトはそのドキュメントの中でのゼロ番目のスタイルとして{\s0 Normal;}を付け加えます。 ApplixwareによるとRTF規格は明示的なゼロ番目のスタイルを追加することを禁じていますが、Microsoft Wordはたまたま扱えるようになっています。 refentry節を修正するためにスクリプトが\keepnタグを\keepに置き換えます。

  3. Applixware Wordsで新規ドキュメントを開き、RTFファイルをインポートします。

  4. Applixwareで新規ToCを生成します。

    1. そこにあるToCの行の1行目の始めの文字から最終行の最後の文字までを選択します。

    2. Tools->Book Building->Create Table of Contentsで新規ToCをビルドします。 ToCに含めるためヘッダの上から3レベルまでを選択します。 こうするとRTFからインポートされた既存の行がApplixware本来のToCと入れ替わります。

    3. Format->Styleを使ってToCのフォーマットを調整します。 3つのToCスタイルのそれぞれを選択し、FirstLeftインデントを調整します。 下記の値を使用します。

      StyleFirstインデント(インチ)Leftインデント(インチ)
      TOC-Heading 10.40.4
      TOC-Heading 20.80.8
      TOC-Heading 31.21.2

  5. ドキュメントに対し下記に従って作業します。

    • 改ページの調整をします。

    • 表の列幅の調整をします。

  6. ToCのExamplesとFigures部分の右寄せのページ番号を正しい値に修正します。 ほんの数分しかかかりません。

  7. 索引に何もない場合は削除します。

  8. 目次の再生成と調整を行います。

    1. ToCフィールドを選択します。

    2. Tools->Book Building->Create Table of Contentsを選択します。

    3. Tools->Field Editing->Unprotectを選択してToCを解放します。

    4. ToCそのもののエントリであるToCの第1行目を削除します。

  9. 後での最終編集を容易にするためApplixware Words固有のフォーマットでドキュメントを保存します。

  10. Postscriptフォーマットでドキュメントをファイルに"出力"します。

G.3.5. 平文ファイル

インストールする過程の参照用としていくつかの平文によるファイルが配布されています。 INSTALLファイルは第14章と連係していて、異なった内容を説明するためにちょっとした変更が加えられています。 このファイルを生成するには、doc/src/sgmlディレクトリに移動しgmake INSTALLと入力します。 この操作でNetscape Navigator用の平文INSTALL.htmlが作成され、既存ファイルと同じ場所に置かれます。 Netscapeは(lynxw3mと比べて)HTMLを平文に変換するのに最も品質の良い結果をもたらすようです。

HISTORYファイルも同じようにしてgmake HISTORYコマンドで作成できます。 src/test/regress/READMEファイルの場合はgmake regress_READMEです。

G.3.6. 構文検証

ドキュメントのビルドにはとても時間がかかります。 でもドキュメントファイルの正しい構文だけを検証する方法があります。 以下のように入力します。 ほんの数秒しかかかりません。

doc/src/sgml$ gmake check