ドキュメントを作るために下記のツールが使われています。中にはオプショナル のものもあり、そのように表記されています。
これはDocBookそのものの定義です。現在ここでは3.1が使われていますので、その前 もしくは後のバージョンは使わないで下さい。DocBookのXML バージョンもありますが、それも使わないで下さい。
これらはDocBookに必要とされますが、ISOで管理されているため、別に配布されています。
これはSGMLプロセスの基本パッケージです。 これはSGML 構文解析、DSSSL プロセッサ(これはDSSSL スタイルシートを使って SGMLを他のフォーマットに変換する プログラムです)、そしてその他の関連するツールを持っています。 Jadeは現在では、James Clark氏ではなく OpenJadeグループによって維持されています。
これらは、DocBookのソースを例えばHTMLのような他のフォーマット に変換するための指示について書かれています。
このオプションパッケージはマニュアルページを作るために使われます。 あらかじめ必要ないくつかのパッケージがあるので、ウェブサイトで確認して 下さい。
Jadeをフォーマットするバックエンドとして TeXを使うために、JadeTeX をインストールすることも可能です。これはRTFバックエンド から得られるものよりは劣る、プリントされたアウトプットを作りだします。 テーブルは特に問題のある部分です。さらに、手動で結果を仕上げるための 機会もありません。しかしこれは、特にテーブルを使わない簡単なドキュメントでは ちゃんと動きます。JadeTeXとスタイルシートは 改良を続けており、時とともによりよくなることでしょう。
ここではドキュメントを作るために必要な様々なツールのためのインストールメソッド の経験をまとめました。これらのツールを使うための、他のパッケージも配布されている かもしれません。もしあれば、ドキュメントのメーリングリストに連絡して下さい。 ここに情報を加えたいと思います。
多くのベンダーはDocBook作成用の完全なRPMセットを配布しています。それは大体レッドハット ソフトウェアのdocbook-toolsに基づいています。 インストールする際に、"SGML"もしくは後述のパッケージを探して下さい。 sgml-common, docbook, stylesheets, openjade (または jade)。sgml-toolsも必要とされる 可能性があります。もし使用した配布元がこれらを用意していない場合は、他の大きな ベンダーを利用できるはずです。
FreeBSDのドキュメントプロジェクトそのものはDocBookを多用しているため、 FreeBSDで使えるドキュメントツールの完全な"ports"があるのも 不思議ではありません。FreeBSD上にドキュメントを作るためには、後述のportsを インストールすることが必要です。
textproc/sp
textproc/openjade
textproc/docbook-310
textproc/iso8879
textproc/dsssl-docbook-modular
ports は/usr/local/share/sgml/catalogのメインカタログファイル を更新しない可能性があります。下記の行を入れることを忘れないで下さい。
CATALOG "/usr/local/share/sgml/docbook/3.1/catalog"もしもファイルを編集したくない場合は、コロンで区切られたカタログファイルのリスト (上記のようなもの)に環境変数SGML_CATALOG_FILES を設定することもできます。
FreeBSDのドキュメントツールに関する更に詳しい情報は、FreeBSD ドキュメントプロジェクト使用法で見ることができます。
Debian GNU/Linuxに使うことのできるドキュメントツール にはフルセットのパッケージがあります。インストールするためには下記を使って下さい。
apt-get install jade apt-get install docbook apt-get install docbook-stylesheets
DocBookツールのマニュアルインストールプロセスはなにかと複雑ですから、 もしすでにできているパッケージがあったらそれを使ったほうが良いでしょう。 ここでは標準的なセットアップとほぼ標準的なインストールパスについてのみ 説明します。詳しいことはそれぞれのパッケージのドキュメントを見て、 SGML紹介の部分を読んで下さい。
OpenJade のインストールは、GNU式の./configure; make; make install 構築プロセスを提供します。詳細はOpenJadeのソース配布の中でみつけることが できます。内容は
./configure --enable-default-catalog=/usr/local/share/sgml/catalog make make install"デフォルトカタログ"をどこに置いたかを覚えておくようにして下さい。 下記で必要になります。放っておいても構いませんが、その場合はあとでjade を使うはいつでも環境変数 SGML_CATALOG_FILESがそのファイルを指すように設定する必要があります。
更に、dsssl のどこかのディレクトリからファイル dsssl.dtd, fot.dtd, style-sheet.dtd, catalogを /usr/local/share/sgml/dssslにインストールして下さい。 (もしくはディレクトリ全体をコピーして下さい。)
DocBook V3.1を取得してください。
アーカイブを解凍して下さい。
$ unzip -a docbk31.zip
それらのファイルを/usr/local/share/sgml/docbook31ディレクトリ において下さい。(正確にこの場所でなくても構いませんが、これは比較的標準的な場所です。)
ファイル/usr/local/share/sgml/catalog(もしくはインストール時に jadeに設定したもの)を作成し、下記のような行を加えて下さい。
CATALOG "docbook31/docbook.cat"
オプションとして、ファイルdocbook.catを編集して DTDDECLを含む行をコメントアウトか削除することもできます。 もしそれをしなければjadeが警告を出しますが、 それ以外に害はありません。
ISO 8879 character entitiesアーカイブをダウンロードして解凍し、 ファイルをDocBookファイルを置いたのと同じディレクトリに 置いて下さい。
スタイルシートをインストールするためには、配布されたキットを解凍し、例えば /usr/local/share/sgml/stylesheetsのような適宜の場所において 下さい。(アーカイブが自動的にdocbookのサブディレクトリ を作成します。)
JadeTeXをインストールして使うためには、 TeXとLaTeX2eが インストールされていることが必要です。これに含まれるのは、サポート されているツールと グラフィックスのパッケージ、 Babel, AMSフォントと AMS-LaTeX, PSNFSSの拡張 と"the 35 fonts"の付属キット PostScriptを作成する dvipsプログラム。 fancyhdr, hyperref, minitoc, url と ot2enc, そしてもちろん JadeTeX 自体。これらは全て CTANサイトで 見つけることができます。
JadeTeXには、ダウンロードした際には インストールガイドがついていませんが、必要な物を示すmakefile がついています。これにはディレクトリcooked も含まれており、ここでは必要とされるマクロパッケージもいくつかありますが これが全てではなく完全でもありません。(少なくとも私の知る限りでは。)
jadetex.fmtフォーマットのファイルを作る前に、 jadetex.ltxファイルを編集しBabel を自分の環境に合わせる必要があるとあると思います。そのための行はこのように なるはずです。
\RequirePackage[german,french,english]{babel}[1997/01/23]
明白ですが、自分が必要な言語だけをリストしBabel
をconfigureしてください。
PostgreSQLのドキュメントソースと一緒に JadeTeXを使う場合、二度目の起動で TeXが止まり容量を越えたと言われることが あります。これはJadeTeXが相互参照する情報 を作る方法のせいです。TeXはもちろんもっと 大きいデータ構造サイズの大きいものともコンパイルすることができます。 その際の詳細はインストールによってことなります。