ドキュメントを作成する前に、プログラム自身を作るときと同じように configureスクリプトを実行する必要があります。 実行が終り近くなった時の出力は以下のようになるはずです。
checking for onsgmls... onsgmls checking for openjade... openjade checking for DocBook V3.1... yes checking for DocBook stylesheets... /usr/lib/sgml/stylesheets/nwalsh-modular checking for sgmlspl... sgmlsplもしonsgmlsもnsgmlsも見つからない場合、 残りの４行は表示されません。nsgmlsはJadeパッケージの 一部です。もし"DocBook V3.1"が見つからない場合は、DocBook DTDキット がjadeの見つけられる場所にインストールされていないか、カタログファイルが正しく 設定されていません。上記のインストールヒントを見て下さい。DocBookスタイルシートは 比較的標準的な場所で探されます。しかし、もし別の場所に置いた場合は環境変数 DOCBOOKSTYLEに場所を設定してからconfigure を再実行してください。
全ての設定が終ったら、ディレクトリdoc/src/sgml に移動して下記のコマンドの一つを実行してください(GNU make を使うのを 忘れないで下さい)：
管理者用ガイドのHTML バージョンの作り方
doc/src/sgml$ gmake admin.html
同じもののRTFバージョン
doc/src/sgml$ gmake admin.rtf
JadeTeXでDVI 形式を作る場合：
doc/src/sgml$ gmake admin.dvi
そしてDVI形式から Postscript 形式を作ります。
doc/src/sgml$ gmake admin.ps
Note: 公式なポストスクリプトフォーマットのドキュメントは違った 方法で作られます。下のSection DG2.3.3を見て下さい。
doc/src/sgmlにHTMLドキュメント を作るときは、その結果できるファイルが本と一致しないことが多々あります。 ですから、それらのファイルは標準の配布ではそのディレクトリには 入っていません。代わりに、それぞれの本のファイルはインストール時 には解凍されないtarパッケージに格納されています。HTML ドキュメントパッケージのセットを作るには以下のコマンドを使って下さい。
cd doc/src gmake tutorial.tar.gz gmake user.tar.gz gmake admin.tar.gz gmake programmer.tar.gz gmake postgres.tar.gz gmake install配布された物の中には、docディレクトリ のなかにこれらのアーカイブがありデフォルトでは gmake installでインストールされます。
DocBookREFENTRYページ をマニュアルページに合った*roff出力に変換するためには、 docbook2manを利用します。マニュアルページは HTMLバージョンと似ているtarアーカイブとしても配布さ れています。マニュアルページのパッケージを作る場合は下記のコマンドを 使って下さい。
cd doc/src gmake manこれによってdoc/srcディレクトリに tarファイルが作られます。
作られたマニュアルは沢山の紛らわしい出力を残すため、質の高い結果 を残すためには特別な処置をとらなければなりません。この部分にはまだ 改善の余地があります。
ポストスクリプトのハードコピードキュメントはSGML ソースコードをRTFに変換し、 ApplixWare-4.4.1にインポートして作られます。 簡単な掃除のあと(次のセクション参照)結果がポストスクリプトファイル に出力されます。
ポストスクリプトハードコピーを作成する間、RTFリペア、ToC作成、 ページ区切れ目調整などを含む部分が処理されます。
Applixware RTFの掃除
ハードコピープロシージャの総合的な部分であるjadeはボディテキストのデフォルト スタイルの指定を省略します。過去には、この未処理の問題が長い Table of Contents (ToC)作成へと導きました。しかし、ApplixWareの 方々の素晴しい協力により症状は改善され使うことができるようになりました。
下記のようなコマンドでRTF入力を作成して下さい(これは一例です)：
% cd doc/src/sgml
% make tutorial.rtf
RTFファイルが正しく全てのスタイル、特にデフォルトスタイル、 を指定するように修正して下さい。フィールドはvi もしくは後述する小さなsedプロシージャを使って 追加することができます。
#!/bin/sh
# fixrtf.sh
# Utility to repair slight damage in RTF files generated by jade
# Thomas Lockhart <lockhart@alumni.caltech.edu>
#
for i in $* ; do
mv $i $i.orig
cat $i.orig | sed 's#\\stylesheet#\\stylesheet{\\s0 Normal;}#' > $i
done
exit
スクリプトがドキュメントの中で{\s0 Normal;}を
zero-thスタイルとして追加している部分で使って下さい。ApplixWareによると
RTF標準は暗黙のzero-thスタイルを追加することを禁じるそうですが、今回の
場合はマイクロソフトが扱っています。
Applix Wordsで新しいドキュメントを開き、 RTFファイルをインポートして下さい。
ApplixWareを使って新しいToCを作って下さい。
すでにあるToCを、一行目の一文字目から最終行の最終文字まで選択して下さい。
Tools.BookBuilding.CreateToCを使って新しいToCを作って 下さい。最初の3レベルをToCに含むために選択して下さい。これが すでにRTFからインポートされた行をApplixWareのToCと入れ換わります。
Format.Styleを使ってToCのフォーマットを調整 してください。まず3つのToCスタイルをそれぞれ選択し、インデントを FirstとLeftに調整します。 下記の値を使って下さい。
Table DG2-1. テーブルの目次のためのインデントフォーマット
| スタイル | 第１インデント(インチ) | 左インデント(インチ) |
|---|---|---|
| TOC-Heading 1 | 0.6 | 0.6 |
| TOC-Heading 2 | 1.0 | 1.0 |
| TOC-Heading 3 | 1.4 | 1.4 |
下記のようにドキュメントにしたがって作業して下さい。
ページの切れ目を調整する。
テーブルのコラムの幅を調整する。
ドキュメントに図を挿入して下さい。ApplixWareツールバーのセンタリングマージン ボタンを使ってそれぞれの図をセンタリングして下さい。
Note: すべてのドキュメントに図があるわけではありません。 SGMLのソースファイルを"graphic"という 文字列でgrepして、ドキュメントのどの部分に図があるかを確認して下さい。 いくつかの図はドキュメントの違った部分でくり返し使われています。
ToCのExamplesとFiguresの部分の右付されたページ数を正しい値に直して下さい。 一つのドキュメントにつき数分ほどしかかかりません。
もし参考文献リストがある場合、短いフォーム の参照タイトルは削除して下さい。DocBook Norm Walshのスタイルシートはこれらをプリントアウトしますが、これは 次に述べる情報のサブセットです。
最終編集なども簡単にできるように、Applix Wordsフォーマットでドキュメントを保存して下さい。
ポストスクリプトフォーマットのファイルにドキュメントを書き出して下さい。
gzipを使ってポストスクリプトファイルを圧縮 して下さい。圧縮されたファイルはdocディレクトリに 置いて下さい。
いくつかのファイルはプレーンテキストとしてインストールプロセス時に読むために 配布されています。INSTALLファイルが管理者用 ガイドの中の章と呼応しています(違った内容を説明するためにいくつか 小さな変更が加えられています)。このファイルを作るためにはディレクトリ doc/src/sgmlに移動し、gmake INSTALLと入力して下さい。これでINSTALL.html というファイルが作られ、Netscape Navigatorでテキスト として保存し既にあるファイルの中に出力することが可能になります。 NetscapeはHTMLとテキストの変換では 一番質の高いものを提供しているようです(lynxと w3mと比べて)。
ファイルHISTORYも、コマンドgmake HISTORY を使って同じように作ることができます。その結果できたファイルから、目次は手動で 削除して下さい。
それほど頻繁に変更されないため、ファイルsrc/test/regress/README の作成は完全には自動化されていません。HTMLバージョンの 管理者用ガイドを作ったら、その結果できたファイル regress.htmlとregress-platform.html をNetscapeを使ってテキストに変換して下さい。 そしてそのテキストファイルを一緒に貼り付け好きなように編集して下さい(例： ナビゲーションバーの削除、参照を別のチャプターに移動させる)。