English Version >

DITA-XLIFF-RoundTrip環境構築ノウハウ

はじめに

オープンソースであるDITA-XLIFF-RoundTripを使用することで、DITAコンテンツをXLIFFに変換、
また、XLIFFで翻訳されたコンテンツをDITAに戻すことが出来ます。

この環境を構築するにあたりサイト上に記載されている内容では一部情報が不十分であることが確認されています。
本資料はこの構築作業を円滑に進めるためのノウハウを記しています。

本資料に関して以下の注意事項をご了解ください

  • 本ソフトウェアはオープンソースですが、使用においてはhttps://sourceforge.net/projects/ditaxliff/のサイト上に記載されている使用条件に準じます。
  • この構築作業で使うソフトウエア、および構築作業に関わるサポートはDITAコンソーシアムジャパンでは行いません。
  • 本資料の使用によって生じた損害などに対し、DITAコンソーシアムジャパンは一切の責任を負いません。

 

準備:DITA-OpenToolKit と DITA-XLIFF-RoundTripのダウンロード

  1. DITA-XLIFF-RoundTripのダウンロード
  2.  1) https://sourceforge.net/projects/ditaxliff/ にアクセスします。
     2) "Download" をクリックして DITA-XLIFF-RT-4X2.0.2.zip をダウンロードします。
     3) zipファイルを展開すると、"xliff-v12"など4つのフォルダとDITA-XLIFF-RT-4X2-readme_revised.txtが生成されます。

  3. DITA-OpenToolKitのダウンロード
  4.  1) https://www.dita-ot.org/ にアクセスします。
     2) "Download" をクリックして https://www.dita-ot.org/download に移動します。
     3) 最新版は3.0.3ですが、DITA-XLIFF-RoundTripのマニュアルに記載されている
       Version1.8を選択しました。
     4) "Download Latest Version"バナーを選択するとDITA-OT1.8.5_standard_bin.zipが
      ダウンロードされますが、私はDITA-OT1.8.5_full_easy_install_bin.zip(38.3MB)
      を選択しました。
     5) zipファイルを展開すると、DITA-OpenToolKitの環境ができます。
     (この他、Javaとantをインストールする必要があります。)

 

DITA-XLIFF-RoundTrip環境の構築

以下、DITA-XLIFF-RT-4X2-readme_revised.txt の手順に従って作業をします。
本手順書では手順の中で、発表者が苦労した点のみを記述しています。
従って実際の手順については、DITA-XLIFF-RT-4X2-readme_revised.txtを参照してください。

  1. プラグインのインストール
  2. DITA→XLIFF 変換(サンプル)
  3. XLIFF→DITA 変換(サンプル)

Installing the Plugins
======================

  1. Download the latest distribution package for the plugins from:
    <http://sourceforge.net/projects/ditaxliff/files/latest/download>.
  2. Unzip the package to the `plugins` directory of your DITA-OT installation.
  3. From the root directory of your DITA-OT installation, run the start command
    for your operating system (either `startcmd.bat` or `startcmd.sh`).    ←  (*1)
  4. In the `startcmd` environment, run the following command to integrate the
    new plug-ins into your toolkit installation:
  5. $ ant -f integrator.xml
    

 

中略

 

Running the Conversions
=======================

These instructions will provide a starting point. You can use the samples and just leave everything else as is.
Or you can use your own DITA sample projects and do more robust testing. To do that you will need to edit the integrator and build files.

 

DITA to XLIFF sample
--------------------

  1. Go to the `plugins/xliff-v*` directory of your DITA-OT installation,
    depending on the XLIFF version you want to generate.
  2. In the DITA-OT command window, execute: `ant -f integrator.xml`.
    (You only need to do this once.)
  3. Look at the `sample.ditamap` file in the `samples/guitars` folder.
    The sample build file points to this map in the `args.input` property.
  4. In the `xliff-v*` directory, execute `ant -f build_dita2xliff.xml`.       ← (*2)
  5. Go to the `xliff-v*/out/samples/xliff` folder.
    Note the `d_x.xml` file. This is a valid XLIFF file that has all your maps,
    topics, and required structure to translate and reassemble your DITA
    project. Feel free to translate it with your favorite XLIFF editor.

    Note: if your CAT tool uses custom extensions, you may need to include its
    XML Schema in the XLIFF to DITA step.
  6. Change the name of the translated file to `d_x_translated.xml`, and place
    it in the `plugins/ditafromxliff-v*/in` directory.

 

XLIFF to DITA sample
--------------------

  1. Go to the `plugins/ditafromxliff-v*/in` directory, depending on the XLIFF
    version you generated in the sample above.
  2. In the DITA-OT command window, execute: `ant -f integrator.xml`.
    (You only need to do this once.)
  3. Take a look at the `d_x_translated.xml` file (the same file you translated).
    The build file is pointed at this XLIFF file. (Saxon 9 uses the schemas in
    this folder to validate the XLIFF file.)
  4. In `plugins/ditafromxliff-v*`, execute `ant -f build_ditafromxliff.xml`.  ← (*3)
  5. Go to the `ditafromxliff-v*/out/samples/ditafromxliff` directory.
    Look in the `translated` folder. You will find your translated DITA project.
  6. SMALL BUG: If you want to re-run this step, you must first remove the
    `deleteme.txt` file (or run the `must-clean4each-round.bat` script).

 

注意点1: (*2)のコマンドがエラーとなる

(*1)の作業は、Installing the Plugins の中でだけ実行すればよいように読めますが、そうではありません。
Running the Conversions 章での作業を行う際には、必ず(*1)の手順で起動します。

startcmd.bat の中で、(*2)や(*3)で使用するjavaのクラスにパスを設定しているのです。
普通にコマンドプロンプトで実行すると、javaクラスが見つからず、”build failed”となります。

 

注意点2: (*3)のコマンドがエラーとなる

筆者は会社のフロアで作業をしていました。このため、ブラウザなどには「外部接続にプロキシーサーバーを使用する」
設定をしてあります。(*3)で実行される build_ditafromxliff.xml は、その中でW3Cのサイトに接続に行くのですが、
そのためには ant にプロキシの設定を教えてあげる必要があります。
今時の商用アプリであれば、インストーラがブラウザなどほかのアプリの設定を参照して、同じ値をセットしてくれそうなものですが。。。

ant の起動オプションに追加することもできるでしょうが、筆者は以下の1行を(*1)のstartcmd.batに追加して、
社内環境用の別名ファイルにしました。社外環境での作業と簡単に切り替えられるようにです。

 $ set ANT_OPTS=%ANT_OPTS% -Dhttp.proxyHost=proxyzzzz.yyy.xxx.co.jp -Dhttp.proxyPort=xxxx

 

----------------------------------------------------------------------------------------
執筆 DITAコンソーシアムジャパン コンテンツ・ローカリゼーション部会
----------------------------------------------------------------------------------------