ドキュメントのビルド

PostgreSQL 8.0.0 文書
前のページ | 巻戻し | 付録 G. Documentation | 早送り | 次のページ

# 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 を使って印刷可能なドキュメントを作成したい時は以下のコマンドの中から一つを選んでください。

- DVI 形式を作るには次のようにします。

      doc/src/sgml$ gmake postgres.dvi

- DVI から Postscript を生成するには次のようにします。

      doc/src/sgml$ gmake postgres.ps

- PDF を作るには次のようにします。

      doc/src/sgml$ gmake postgres.pdf

  （もちろんPostscriptからもPDFバージョンを作成できますが、PDFを直接生成するとハイパーリンクを含めた拡張機能が伴われます。）

## 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スタイルのそれぞれを選択し、`First`と`Left`インデントを調整します。 下記の値を使用します。

      Style | First インデント（インチ） | Left インデント（インチ）
      --- | --- | ---
      `TOC-Heading 1` | `0.4` | `0.4`
      `TOC-Heading 2` | `0.8` | `0.8`
      `TOC-Heading 3` | `1.2` | `1.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は（lynxやw3mと比べて）HTMLを平文に変換するのにもっとも品質の良い結果をもたらすようです。

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

## G.3.6. 構文検証

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

    doc/src/sgml$ gmake check

前のページ | ホーム | 次のページ
ツールセット | 上に戻る | ドキュメントの起草