Velocity - Velocity Installation

Velocityについて

コミュニティ

ドキュメント

比較

ツール

日本語訳について

日本語訳について

インストール

Velocity は、Java 2 VM がインストールしてあるさまざまなプラットホームで実行できます。ソースコードから Velocity をコンパイルしたい場合には、J2SDK が必要です。

配布から Velocity をビルドするのに必要なものはすべて、 CVS または夜間ビルドから入手できます。また、優れた Java ベースのビルドツールである Ant をインストールする必要があります。 Ant もまた Jakarta プロジェクトで、ここにあります。
[訳注：現在、Ant は Apache のトップレベルプロジェクトとして、 Jakarta プロジェクトから独立しています。サイトも http://ant.apache.org/ に移動しました。]

配布のディレクトリツリーは、以下のようになります
jakarta-velocity
  /build        - ビルドスクリプトが含まれる
  /bin          - 構築された jar や class が収まる場所
  /src          - Velocity, Anakia, Texen のソースコード
  /docs         - HTML 形式のドキュメント
  /docs/api     - Velocity のソースの Javadoc
  /examples     - サンプルとドキュメントのコード
  /convert      - WebMacro テンプレートからの変換ツール
  /test         - テストプログラムとテンプレート
  /xdocs        - ドキュメントのソース

ビルド

Velocity を簡単に一貫性をもたせてビルドするには、Apache のプロジェクトである Ant のバージョン 1.3 以降が必要です。
[訳注：上の訳注のとおり、URLが変わっています。このリンクは変更済みです]
Ant のインストール指示に従って正しくそれをインストールしていることを前提にします。インストールも難しくありませんし、素晴らしいプログラミングツールだと思います。

以下の各手順では、あなたが CVS からの配布か夜間ビルドの取得に成功していて、夜間ビルドの場合は、解凍に成功していることを前提にしています。そして、「jakarta-velocity」ディレクトリ(配布ツリーのルート) で作業を行っていると仮定しています。ディレクトリ参照はすべて「jakarta-velocity」の相対パスです。

build ディレクトリに移動してください (cd build)。それから、jarファイルをビルドするには、単に以下のようにタイプしてください。
ant
このスクリプトを実行すると、Velocity 配布ディレクトリの中に bin ディレクトリが作成されます。 bin ディレクトリにはコンパイルされたクラスファイル (classes ディレクトリ内にあります) と velocity-XX.jar ファイル (XX は現在のバージョン番号) が入っています。クラスパスを Velocity の .jar ファイルを含めて更新したことを確認してください。

ビルドターゲット (開発者ガイドで詳述) のいずれかをビルドするには、コマンドラインでターゲット名を加えるだけです。例えば、Javadoc API ドキュメトをビルドするには以下のようにします。
ant javadocs
Velocity は、「独自に」、つまりクラスパスに依存せずにビルドすべきです。 Velocity のビルドでエラーが出た場合には、別の夜間ビルドを試してみるか (時にはミスがあって、夜間スナップショットの時点で必要なものが CVS にそろってないこともあります)、CVSから再取得してください (開発者によるチェックイン中にCVS スナップショットを取得したのかもしれません)。

問題がずっと解決しないようでしたら、迷わず、メーリングリストを通して Velocity コミュニティで質問してください。メーリングリストについてはここで情報を得られます。Jakarta メーリングリストに参加するためのガイドラインを読んで理解してください。

インストール後のテスト

Velocity 開発者は自動テスト機能を使いますが、この機能は配布にも含まれています。 Velocity のビルドで全て問題ないことを確認するのに使うことができます。

テストスイートを実行するには、test というビルドターゲットを使ってビルドします。
ant test
うまくいけば、出力はこうなります。
test:
Running JUnit template tests for Velocity ...
Adding TemplateTestCase : arithmetic
Adding TemplateTestCase : array
Adding TemplateTestCase : block
   .
   .
   .
Adding TemplateTestCase : math
Adding TemplateTestCase : range
Adding TemplateTestCase : get
Adding TemplateTestCase : velocimacro2
Adding TemplateTestCase : foreach-type
Adding ContextSafetyTestCase.
......................................
Time: 2.553

OK (38 tests)
テスト数は上記と異なるかもしれませんが、テストの実行後に 'OK' が表示されればすべて OK です。これで Velocity を使うことができます。