でHello World

DITAは正直なところ、とっつきにくいと思います。
原因のひとつとして、(知る限り)日本語でのHello Worldの書き方が無いことがあげられると考えています。

DITA-OTのインストールにはいくつものサンプルが含まれていますが、それらはDITAの特徴を知るためには役立ちますが、取っ掛かりに何が必要なのかを知るには規模が大きすぎます。また、DITAのビルドはパス指定でのファイルの呼び出しやインクルードが相当行われているため、サンプルの改造からの導入は比較的容易なものの、いざ独立した作業ディレクトリで作業を始めようとすると、どのファイルをどう用意したらいいのかさっぱりわかりません。

あれこれつつきまわして、ある程度DITA/DITA-OTの使い方がわかってきたので、DITA-OTのインストールからHelloWorldまでをまとめておきます。

※我流なのでご注意

動作環境

ここではWindowsを想定します。

DITA-OTで一部使われる実行バイナリはJava(.jar)なので、Unix環境でもパス指定等を読み替えればそのまま適用可能と思われます。

Java実行環境のインストール

DITA-OTでのビルドにはJavaが必要です。
SunのサイトからJava JREをダウンロードし、インストールしてください。

• http://java.sun.com/javase/downloads/index.jsp

DITA-OTのインストール

sourceforgeからダウンロードし、インストールしてください。

• http://sourceforge.net/projects/dita-ot/files/
  • full_easy_install_bin を選択します。

インストールは任意のディレクトリに展開するのみです。
ここでは、インストール先を v:\workspace\DITA-OT とします。
また、ユーザ作業ディレクトリとして v:\workspace\document を作成しておきます。
最近はあまり心配要らないようですが、全角文字やスペースが含まれるパスは避けたほうが無難と思われます。

動作確認

DITA-OT付属のサンプルがビルドできることの確認

インストール先のディレクトリ（v:\workspace\DITA-OT）にある startcmd.bat を、ダブルクリックして起動します。

次のコマンドを実行する

ant -f samples\ant_sample\sample_xhtml.xml

次のように"SUCCESSFUL"が表示されれば成功。

BUILD SUCCESSFUL
Total time: 15 seconds
V:\workspace\DITA-OT>

DITA-OT\samples\ant_sample\out\samples\xhtml に、ファイルが生成されます。

ant -f samples\ant_sample\sample_pdf.xml を実行すれば、PDFが生成されます。

ユーザの作業ディレクトリの準備

v:\workspace\document に、次のファイルをコピーし、リネームします。

  v:\workspace\DITA-OT\samples\ant_sample\template_xhtml.xml
  ↓
  v:\workspace\document\build.xml

  v:\workspace\DITA-OT\startcmd.bat
  ↓
  v:\workspace\document\startcmd.bat

build.xmlの編集

コピーしたテンプレートファイルには、書き換えるべき箇所が @NAME@ のパターンで書かれているので、適宜書き換えます。
その際、"@NAME@_xxx"の _xxxの箇所を変更しないように注意。

変更箇所	変更例	備考
@PROJECT.NAME@	document	プロジェクト名。出力に影響しない。
@DELIVERABLE.NAME@	document	ビルドターゲットの依存関係に影響。2箇所あり同じ文字列にする。プロジェクト名と同じである必要は無い。
@DITA.INPUT@	document.xml	ソースとなるditamapファイルを指定する。
@OUTPUT.DIR@	out	出力先のディレクトリを指定する。この場合、v:\workspace\document\out ディレクトリが出力時に作られる

また、下記の箇所を書き換える

  
  ↓
  

末尾の '..' を 'DITA-OT' に

startcmd.batの編集

下記のDITA_DIRの箇所を書き換えます。

REM Get the absolute path of DITAOT's home directory
set DITA_DIR=%~dp0

REM Get the absolute path of DITAOT's home directory
set DITA_DIR=..\DITA-OT\

DITAソースファイルの作成

ファイル名 document.xml で下記のようなファイルを作成します

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "../DITA-OT/dtd/concept.dtd">
<concept id="hello_world">
<title>Hello World</title>
<conbody>
  <p>Hello World !!</p>
</conbody>
</concept>

startcmd.batでコマンドプロンプトを起動し、

ant -f build.xml を実行します。

out ディレクトリにhtmlファイルが生成されれば成功。