文書の構築

PostgreSQL 9.1.1文書
前のページ | 巻戻し | 付録 I. ドキュメント作成 | 早送り | 次のページ

# I.3. 文書の構築

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

## I.3.1. HTML

HTML形式の文書を作成するには次のようにします。

    doc/src/sgml$ gmake html

これはデフォルトでの対象です。 出力は`html`サブディレクトリに作成されます。

適切なインデックスを作成するために、構築時何回か同一の処理を行う可能性があります。 インデックスを考えず、出力の検証を行いたいだけであれば、以下のように`draft`を使用してください。

    doc/src/sgml$ gmake draft

1つのHTMLページとして文書を作成するためには以下を使用します。

    doc/src/sgml$ gmake postgres.html

## I.3.2. マニュアルページ

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

    cd doc/src/sgml
    gmake man

## I.3.3. JadeTex からの印刷

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

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

      doc/src/sgml$ gmake postgres-A4.ps

  U.S.レターサイズの場合は次のようにします。

      doc/src/sgml$ gmake postgres-US.ps

- PDFを作るには

      doc/src/sgml$ gmake postgres-A4.pdf

  または、

      doc/src/sgml$ gmake postgres-US.pdf

  のようにします。 （もちろんPostscriptからもPDFバージョンを作成できますが、PDFを直接生成すれば、ハイパーリンクを含めた拡張機能を持たせるようにできます。）

PostgreSQL文書の構築にJadeTeXを使用する場合、おそらくいくつかのTeXの内部用パラメータを増加させなければなりません。 これらは`texmf.cnf`ファイルで設定可能です。 本書執筆時点では、以下の設定で動作します。

    hash_extra.jadetex  = 200000
    hash_extra.pdfjadetex  = 200000
    pool_size.jadetex = 2000000
    pool_size.pdfjadetex = 2000000
    string_vacancies.jadetex = 150000
    string_vacancies.pdfjadetex = 150000
    max_strings.jadetex = 300000
    max_strings.pdfjadetex = 300000
    save_size.jadetex = 15000
    save_size.pdfjadetex = 15000

## I.3.4. テキストのはみ出し

テキストが印刷マージンよりも広くなりすぎることがあります。 さらに極端な場合、印刷ページよりも広くなりすぎることがあります。 例えば、改行がテキストや幅広の表などです。 過度に幅広のテキストは"Overfull hbox"というメッセージをTeXのログファイル(`postgres-US.log`または`postgres-A4.log`)に残します。 インチ単位で72ポイントありますので、72ポイントを超えた時におそらく幅が広すぎて印刷ページに合わないと何かしらに報告されます(1インチのマージンを仮定)。 SGMLテキストがはみ出す可能性があるかどうかを見つけるためには、上のはみ出しに関するメッセージで示されている先頭ページ番号(例えば`[50 ###]` (page 50))を見つけ、PDFファイル内の次のページ(例えばpage 51)以降を読み、はみ出したテキストを探します。 それに合わせてSGMLを調整します。

## I.3.5. 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フォーマットで文書をファイルに"出力"します。

## I.3.6. 平文ファイル

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

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

## I.3.7. 構文検証

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

    doc/src/sgml$ gmake check

前のページ | ホーム | 次のページ
ツールセット | 上に戻る | 文書の起草