文書を処理する過程で次のようなツールが使われます。 そのうちのいくつかは付記されているように省略しても構いません。
DocBookそのものの定義です。 現在はバージョン4.2を使用しており、これより古いまたは新しいバージョンは使用できません。 DocBook DTDのSGML版とXML版が必要です。 これらはたいてい別々のパッケージにあります。
DocBook SGMLに必要なものですが、ISOで保守されているため別に配布されています。
DocBookのソースをHTMLのような他のフォーマットに変換する処理手順が含まれています。
現在最低必要なバージョンは1.77.0ですが、最良の結果を得るために入手可能な最新の版を使うことをお勧めします。
SGMLを処理する基本パッケージです。 DSSSLプロセッサのOpenJadeは最早必要ではなく、SGMLからXMLに変換するためにOpenSPパッケージだけが必要であることに注意してください。
xmllint
のためのLibxml2このライブラリとそこに含まれるxmllint
ツールはXMLを処理するのに使われます。
PostgreSQLのコードを構築する時にも使われますので、多くの開発者はすでにLibxml2をインストールしているでしょう。
しかしながら、xmllint
は別のサブパッケージからインストールする必要があるかもしれないことに注意してください。
xsltproc
のためのLibxsltxsltproc
はXSLTプロセッサ、すなわち、XSLTスタイルシートを使ってXMLを他のフォーマットに変換するプログラムです。
これは変換、とりわけXMLからPDFへの変換のためのプログラムです。
文書を作成するために必要な様々なツールのインストール方法についての経験をまとめました。 以下に記載します。 これらのツールは別にパッケージ化されて配布されていることも考えられます。 もしそのような配布物を見つけた場合はdocのメーリングリストに報告してください。 そのような情報をここに付け加えたいと思います。
必要なファイルはインターネットからダウンロードされ、ローカルにキャッシュされるので、DocBook XMLとDocBook XSLTスタイルシートをローカルにインストールせずに済ませることもできます。
オペレーティングシステムのパッケージで特にスタイルシートの古いバージョンしか提供されていない場合や、パッケージが全く利用できない場合には、実際、これが好ましい解決法でしょう。
詳細はxmllint
とxsltproc
の--nonet
オプションを参照してください。
要求されるパッケージをインストールするには以下のようにしてください。
yum install docbook-dtds docbook-style-xsl fop libxslt opensp
FreeBSDのドキュメントプロジェクトそのものがDocBookのヘビーユーザですから、FreeBSD上で使用できる文書作成用ツールの「ports」一式が揃っていることは驚くに当たりません。 FreeBSD上で文書を構築するには以下のportsが必要です。
textproc/docbook-sgml
textproc/docbook-xml
textproc/docbook-xsl
textproc/dsssl-docbook-modular
textproc/libxslt
textproc/fop
textproc/opensp
pkg
で必要なパッケージをインストールするには以下を使います。
pkg install docbook-sgml docbook-xml docbook-xsl fop libxslt opensp
提供されているMakefileはFreeBSDのmake
用ではありませんので、doc
ディレクトリから文書を作成するにはgmake
を使うことが必要でしょう。
FreeBSDでの文書作成ツールについてのさらに詳しい情報はFreeBSD Documentation Project's instructionsにあります。
Debian GNU/Linux用の文書作成パッケージの一式が揃っています。 インストールには以下を使います。
apt-get install docbook docbook-xml docbook-xsl fop libxml2-utils opensp xsltproc
MacPortsを使っているのであれば、以下のようにすれば設定されます。
sudo port install docbook-sgml-4.2 docbook-xml-4.2 docbook-xsl fop libxslt opensp
DocBookツールを手作業でインストールするのは何かと複雑ですから、もし既にできているパッケージがあるならばそちらを使った方が良いでしょう。 ここでは、標準的なインストール手順として、一般的な機能以外を持たせない標準的な設定のみを説明します。 詳しいことはそれぞれのパッケージの文書とSGMLの入門資料を読んでください。
OpenSPのインストールは、GNU形式の./configure; make; make install
という構築手順で行います。
詳しいことはOpenSPソース配布物の中にあります。
要約すると次のようになります。
./configure --enable-default-catalog=/usr/local/etc/sgml/catalog make make install
「デフォルトカタログ」をどこに置いたか覚えておいてください。
後で必要になります。
そのままにしておいても構いませんが、後でOpenSPのプログラムを使用する時にはSGML_CATALOG_FILES
環境変数を設定してファイルの場所を指定する必要があります。
(既にOpenSPがインストールされていて残りのツール一式を別の場所にインストールしたい場合にはこの方法を使用する手があります。)
DocBook V4.2を入手します。
/usr/local/share/sgml/docbook-4.2
ディレクトリを作成してそこに移動します。
(正確にこの場所でなくても構いませんが、ここで説明して行く流れの中では筋が通っているものです。)
$
mkdir /usr/local/share/sgml/docbook-4.2
$
cd /usr/local/share/sgml/docbook-4.2
アーカイブを伸長します。
$
unzip -a ...../docbook-4.2.zip
(アーカイブは現在のディレクトリに伸長されます。)
/usr/local/share/sgml/catalog
ファイル(もしくはインストール時にjadeに指定したファイルに)に以下の1行を付け加える編集を行います。
CATALOG "docbook-4.2/docbook.cat"
ISO 8879 character entities archiveをダウンロードし、伸長してできたファイルをDocBookのファイルと同じディレクトリに置きます。
$
cd /usr/local/share/sgml/docbook-4.2
$
unzip ...../ISOEnts.zip
DocBookとISOファイルを置いたディレクトリで以下のコマンドを実行します。
perl -pi -e 's/iso-(.*).gml/ISO\1/g' docbook.cat
(この操作によって、DocBookカタログファイルで使われる名称と実際のISO文字エンティティファイル間での重複が整理されます。)
configure
による検出PostgreSQL本体のプログラムを構築した時のように、文書を構築する際にconfigure
スクリプトを実行する必要があります。
実行が終わる近辺の次のような出力を確認してください。
checking for onsgmls... onsgmls
checking for DocBook V4.2... yes
checking for dbtoepub... dbtoepub
checking for xmllint... xmllint
checking for xsltproc... xsltproc
checking for osx... osx
checking for fop... fop
もしonsgmls
あるいはnsgmls
が見つからなかった場合には以降の試験の一部は飛ばされます。
nsgmls
はOpenSPパッケージの一部です。
自動検出できなかった場合、環境変数NSGMLS
を渡すことで、これらのプログラムの場所を指定することができます。
「DocBook V4.2」が見つからない場合はDocBook DTDキットをOpenSPが見つけられる場所に置かなかったか、もしくはカタログファイルが正しく設定されていません。
前述のインストレーションのヒントを参照してください。