doc-jp 作業環境の構築方法

doc-jp が扱っている文書は SGML 形式で管理されており、 それを元に HTML その他のフォーマットの文書が生成されています。 翻訳作業自体には必要ありませんが、 成果物からの文書の生成が正しく行なえるかどうかを確認する場合には、 以下に示すツールが必要です。

SGML 形式で書かれた文書は主に DocBook DTD と HTML DTD という二つの DTD で書かれています。 前者は Jade, 後者は sgmlnorm というツールで HTML に変換されて WWW 上で公開されています。 また、DocBook DTD で書かれた文書は、HTML 以外のフォーマットに変換して利用することも可能です。

必要なツールのインストール

作業に必要なツールは FreeBSD Ports Collection に含まれています。 必要なツールをすべてインストールするには、 textproc (テキスト処理ツール) の分類の中にある docproj という port を利用してください。 インストールされる主なツールは、以下のとおりです。

Jade

textproc/jade もしくは textproc/openjade

DocBook, HTML, LinuxDoc, ISO8879-1986 などの DTD

texproc/dtd-catalogs

DSSSL DocBook Stylesheets

textproc/dsssl-docbook-modular

Tidy

www/tidy

links (text base の web browser を html formatter として利用)

www/links

画像フォーマット変換ツール

graphics/netpbm, graphics/scr2png

jadetex (明示した場合にかぎり)

print/jadetex

CVSup を使った FreeBSD 文書のソースの取得

FreeBSD ドキュメンテーションプロジェクト、 および日本語ドキュメンテーションプロジェクトでは、 文書を FreeBSD のソースコードと同じ CVS リポジトリで管理しています。 そのため、 anoncvs や cvsup を使うことで文書のソースを取得することが可能です。

以下の例は必要なリポジトリを cvsup で取得した後、 cvs で文書のソースツリーを展開するものです。

リポジトリを取得するための cvsup の supfile を用意します。 必要なコレクションは doc-all, www で、 リポジトリの取得のため tag= の指定はありません。 リポジトリを展開する prefix と sup の status file を展開する base、 利用する cvsup server を指定する host は 適宜指定してください。

*default host=cvsup.jp.freebsd.org
*default prefix=/home/doc-cvs
*default base=/var
*default release=cvs delete use-rel-suffix

doc-all
www

取得したリポジトリからソースツリーを展開します。

cvs -d /home/doc-cvs checkout doc www

ドキュメントツリーを展開するディレクトリに Makefile を置いて 以後の作業を簡便化しておきます。 以下の例では repoget ターゲットで cvsup を実行し、 update で doc, www ディレクトリを cvs で更新します。

repoget:
        cvsup -g -L 1 -P - supfile

update:
        cvs -d /home/doc-cvs update -Pd doc www