hamigaki.png

前のページ 上に戻る ホーム 次のページ

ドキュメントのビルド

ツール
設定
ビルド

SourceForge.jpからリリースパッケージをダウンロードした場合、パッケージにはHTML形式のドキュメントが付属しているが、HTML形式以外のドキュメントが必要な場合やソースコードをSVNリポジトリから取得した場合は、ドキュメントのビルドが必要となる。

ツール

ドキュメントのビルドには以下のツールが利用される。

設定

ドキュメントのビルドには、bjamツールセットxsltproc及びboostbookの設定が必要である。また、PDFやPostscriptを生成する場合はfopの設定が必要である。

xsltproc

module xsltproc {
    rule init ( xsltproc ? )
}
引数 意味 既定値
xsltproc xsltprocの実行ファイルパス $(XSLTPROC)

boostbook

module boostbook {
    rule init ( docbook-xsl-dir ? : docbook-dtd-dir ? : boostbook-dir ? )
}
引数 意味 既定値
docbook-xsl-dir DocBook XSLのインストール先ディレクトリ $(DOCBOOK_XSL_DIR)
docbook-dtd-dir DocBook DTDのインストール先ディレクトリ $(DOCBOOK_DTD_DIR)
boostbook-dir BoostBookのインストール先ディレクトリ $(BOOST_ROOT)/tools/boostbook

fop

module fop {
    rule init ( fop-command ? : java-home ? )
}
引数 意味 既定値
fop-command FOPの実行ファイルパス $(FOP_DIR)/fop
java-home Javaのインストール先ディレクトリ  

xsltprocをC:\Boost\binに、docbook-xslをC:\Boost\share\docbook-xslに、docbook-dtdをC:\Boost\share\docbook-xmlに配置し、Boostパッケージのtools/boostbookディレクトリをC:\Boost\share\boostbookにコピーした場合は、user-config.jamに次のコードを追加する。

import toolset : using ;
using xsltproc : C:/Boost/bin/xsltproc\.exe ;
using boostbook : C:/Boost/share/docbook-xsl : C:/Boost/share/docbook-dtd : C:/Boost/share/boostbook ;

xsltproc-configモジュール及びboostbook-configモジュールを利用すれば次のように記述することもできる。

import xsltproc-config ;
import boostbook-config ;

ビルド

実際にビルドするには、Hamigakiライブラリのdocディレクトリでbjamを実行する。bjamターゲットは次の通りである。

ターゲット名 意味
html 分割HTML
onehtml 単一HTML
man UNIX man ページ
pdf PDF
ps Postscript
docbook DocBook XML
fo XSL Formatting Objects

ターゲットを指定しない場合はhtmlが選択される。


前のページ 上に戻る ホーム 次のページ