Menu

Setup_DocBook_in_Windows_howto

Windows で DocBook 環境を構築する

OmegaT の取扱説明書のソースは、DocBook 形式(XML)です。 そのため、OmegaT で翻訳を行い訳文ファイルを生成しても、それだけでは実際に使われる際の状態を確認することはできません。

たとえば HTML 形式で見るためには、DocBook のソースから HTML ファイルを出力する必要があります。 そしてそのためには、ローカルに DocBook のビルド環境を構築しておく必要があります。

このビルド環境の構築手順は doc_src/Readme.txt に記載されている通りなのですが、Windows 環境に導入しようとすると いろいろ面倒なため、ファイルの入手先や注意点などを以下にまとめておきます。


前提条件

  1. Windows 専用の手順です。Mac、Linux の場合は、ふつうに Readme で手順を確認してください。
  2. OmegaT 専用の手順です。使用するライブラリとそのバージョンは、doc_src/Readme.txt に準じます。ライブラリは最新バージョンではない場合が多いですが、公式ビルドと互換性がないと校正の意味が無いため、あくまで Readme に従います。そのため、この手順で構築される環境は、必ずしも汎用の DocBook 環境ではありません。
  3. ローカルに SourceForge の OmegaT リポジトリの作業コピーが存在するものとします。まだ存在しない場合は、SourceForge の OmegaT リポジトリをチェックアウトを参考に、チェックアウトしておいてください。
  4. 対象者は omegaT-jp プロジェクトのメンバーを想定していますが、自力で取扱説明書をビルドしたい方であれば、誰でも実行できます。

注意点

  1. Windows 7 x64 を前提とした記述になります。他環境の方は、たとえば x86 であれば「C:\Program Files (x86)」のような記述を「C:\Program Files」に適宜読み替えてください。
  2. ファイルのダウンロードに使用するツールによっては、ダウンロードしたファイルにセキュリティ上の制約が掛かっている場合があります。これは後々面倒の元になるので、解凍前にファイルを右クリックして、プロパティからブロックを解除しておいてください。プロパティに [ブロック解除] ボタンが無ければ、この操作は必要ありません。

dbk-security-unblock

インストール手順

OmegaT の場合、DocBook の変換に以下のツールを使用します。

  1. DocBook XSL Stylesheets 1.78.1
  2. DocBook XML 4.5
  3. libxml2-2.7.7
    1. iconv 1.9.2 & zlib-1.2.5
  4. Ant 1.7.1 以上
  5. fop 0.95
  6. Saxon 6-5-5

1. DocBook XSL Stylesheets 1.78.1

rev.5227 (2013/4/23) で 1.75.2 から 1.78.1 に更新されました。

https://sourceforge.net/projects/docbook/files/docbook-xsl/1.78.1/

ここでは docbook-xsl-1.78.1.zip をダウンロードするものとします。

ダウンロードしたら、解凍します。

解凍したフォルダーの中に「docbook-xsl-1.78.1」というサブフォルダーがあるはずなので、それを「dbk」にリネームして、C ドライブ直下に配置します。

作業後のパスは、C:\dbk になります。

2. DocBook XML 4.5

http://www.docbook.org/xml/4.5/

ページの中央辺りに、docbook-xml-4.5.zip へのリンクが張ってあります。

クリックして、ダウンロードします。

解凍すると、docbook-xml-4.5 というフォルダーができます。 このフォルダーは、OmegaT のソースディレクトリと同じ階層に置く必要があります。

つまり、OmegaT のソースが次のような階層にあった場合、

c:\dev\omegat-trunk
c:\dev\omegat-trunk\src
c:\dev\omegat-trunk\doc_src
等...

docbook-xml-4.5 フォルダーを下記のように配置します。

c:\dev\docbook-xml-4.5\ent
c:\dev\docbook-xml-4.5\calstblx.dtd
等...

この位置関係は、dtd が相対参照形式で指定されているため、こんな縛りになっているようです。 別の位置関係の場所に動かすと、XSL 変換に失敗します。

3. libxml2-2.7.7

http://xmlsoft.org/sources/win32/

上記より、libxml2-2.7.7.win32.zip をダウンロードして解凍します。

解凍すると、フォルダーの中にさらに libxml2-2.7.7.win32 というフォルダーがあります。 これを任意のディレクトリに配置します。 どこでもいいのですが、ここでは「Program Files (x86)」に移動するものとします。

移動後は、下記のパスになります。

C:\Program Files (x86)\libxml2-2.7.7.win32

このフォルダーの bin サブディレクトリに、パスを通します。

スタートメニューで [コンピューター] を右クリックして [プロパティ] を選びます ([Windows] キーを押しながら [Break] キーでも良い)。

[詳細設定] タブ -[環境変数...] ボタンをクリックして、システム環境変数の Path 末尾に下記を追加します。

;C:\Program Files (x86)\libxml2-2.7.7.win32\bin

3-1. iconv 1.9.2 & zlib-1.2.5.win32

これは公式の Readme では特に触れていないので、すでに入っている環境も多いのかもしれません。

もう入っている人は、スキップしてください。

この2つは、libxml2 の依存ファイルで、これらが無いと libxml2 が動きません。

ftp://ftp.zlatkovic.com/pub/libxml/

(ミラー)http://xmlsoft.org/sources/win32/

上記より、iconv-1.9.2.win32.zipzlib-1.2.5.win32.zip をダウンロードして、解凍します。

解凍すると、フォルダーの中にさらに、それぞれ iconv-1.9.2.win32 と zlib-1.2.5 というフォルダーがあります。 これを任意のディレクトリに配置します。 どこでもいいのですが、ここでは「Program Files (x86)」に移動するものとします。

移動後は、下記のパスになります。

C:\Program Files (x86)\iconv-1.9.2.win32
C:\Program Files (x86)\zlib-1.2.5

これらの bin フォルダーに、パスを通します。 手順は上の libxml2 の場合と一緒です。

;C:\Program Files (x86)\iconv-1.9.2.win32\bin;C:\Program Files (x86)\zlib-1.2.5\bin

4. Ant 1.7.1 以上

https://ant.apache.org/bindownload.cgi

上記より最新版の Ant をダウンロードして解凍します。

原稿執筆時点では 1.8.4 が最新のようです。

解凍したら任意のパスに配置して、bin にパスを通します。

環境変数 ANT_HOME が定義済みの場合は、こんな感じです。

;%ANT_HOME%\bin

5. fop 0.95

https://archive.apache.org/dist/xmlgraphics/fop/binaries/

fop-0.95-bin.zip をダウンロードして解凍します。

解凍したフォルダーの中の「fop-0.95」を任意のディレクトリに配置します。 どこでもいいのですが、ここでは「Program Files (x86)」に移動するものとします。

移動後は、下記のパスになります。

C:\Program Files (x86)\fop-0.95

6. Saxon 6-5-5

https://sourceforge.net/projects/saxon/files/saxon6/6.5.5/

saxon6-5-5.zip をダウンロードして解凍します。

解凍したフォルダーの中の「saxon6-5-5」を任意のディレクトリに配置します。 どこでもいいのですが、ここでは「Program Files (x86)」に移動するものとします。

移動後は、下記のパスになります。

C:\Program Files (x86)\saxon6-5-5

設定

1. doc_src_paths.xml

C:\dev\omegat-trunk\doc_src\doc_src_paths.xml

C:\dev\omegat-trunk」の部分は、実際の OmegaT リポジトリの作業コピーフォルダーのパスに読み替えてください。

上記ファイルを何か(テキストエディター、XML エディター、IDE など)で開いて、fop-0.95、dbk、Saxon のパスを適切に設定します。

具体的には、次のような箇所があるので、

<project>
    <property name="fop.home" value="C:\Program Files\fop-0.95" />
    <property name="dbk" value="c:\dbk" />
    <property name="saxon" value="C:\Program Files\saxon6-5-5\saxon.jar" />
</project>

上記を、実際のパスに変更します。

ここまでの例の通りだった場合は、下記のようになります。

<project>
    <property name="fop.home" value="C:\Program Files (x86)\fop-0.95" />
    <property name="dbk" value="c:\dbk" />
    <property name="saxon" value="C:\Program Files (x86)\saxon6-5-5\saxon.jar" />
</project>

dbk は、推奨通りにしていれば、変更しなくてもよいはずです。

2. docbook-utf8.xsl

C:\dev\omegat-trunk\doc_src\docbook-utf8.xsl

上記ファイルを何か(テキストエディター、XML エディター、IDE など)で開きます。

こんな風な箇所があるので

<xsl:import href="file:///c:\dbk\html\docbook.xsl"/> 

dbk のパスを適切に設定します。

dbk は、推奨通りにしていれば、変更しなくてもよいはずです。その場合は、確認のみで終わりです。

3. doc_src_paths.xmldocbook-utf8.xsl をコピー

doc_src_paths.xmldocbook-utf8.xsl を、OmegaT の開発フォルダーと同階層にコピーします。

ここまでの例どおりだと、下記のような感じになるはずです。

c:\dev\doc_src_paths.xml
c:\dev\docbook-utf8.xsl

doc_src にあるコピー元のファイルは、実際には使われません。

実行

翻訳中の文書の最新状態を確認する場合は、生成した訳文ファイルを doc_src フォルダーにコピーしておいてください。

doc_src フォルダーで、コマンド プロンプトを起動します。

Windows 7 以降では、[Shift] キーを押しながらフォルダーを右クリックすると、ポップアップメニューに [コマンド ウィンドウをここで開く] というコマンドが現れます。それを選ぶと簡単です。

その状態で、ant でビルドします。

日本語を指定してビルドする例は、下記の通りです。

# 「お手軽スタートガイド」のみビルド
ant -Dlanguage=ja instant-start

# Javahelp 以外すべてビルド
ant -Dlanguage=ja

# HTML をビルド
ant -Dlanguage=ja html

# PDF をビルド
ant -Dlanguage=ja pdf

# Javahelp をビルド
ant -Dlanguage=ja javahelp

通常使うのは、HTML をビルドだけだと思います。

簡単なバッチファイルを作っておくと、良いでしょう。


Related

Wiki: Sync_SFnet_howto