Velocity

Velocityについて

コミュニティ

ドキュメント

ツール

比較

日本語訳について

Installation − インストール

Velocity runs on a variety of platforms that have installed the Java 2 Virtual Machine. The J2SDK is required for users who want to compile Velocity from its source code.

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

Everything required to build Velocity comes with the distribution, which can be obtained from CVS or from the nightly builds. However, you will need to install Ant, an excellent Java-based build tool. Ant is also a Jakarta project, and can be found here.

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

The directory tree of the distribution looks like :

配布のディレクトリツリーは、以下のようになります

jakarta-velocity
  /build        - contains build scripts
  /bin          - where the built jars / classes will go
  /src          - sourcecode for Velocity, Anakia, and Texen
  /docs         - documentation in HTML form
  /docs/api     - Javadocs for Velocity source
  /examples     - example/demonstration code
  /convert      - tools to help convert WebMacro templates
  /test         - test programs and templates
  /xdocs        - source for our documentation
jakarta-velocity
  /build        - ビルドスクリプトが含まれる
  /bin          - 構築された jar や class が収まる場所
  /src          - Velocity, Anakia, Texen のソースコード
  /docs         - HTML 形式のドキュメント
  /docs/api     - Velocity のソースの Javadoc
  /examples     - サンプルとドキュメントのコード
  /convert      - WebMacro テンプレートからの変換ツール
  /test         - テストプログラムとテンプレート
  /xdocs        - ドキュメントのソース


Building − ビルド

To make building Velocity easy and consistant, we require a Jakarta project called Ant version 1.3 or higher to perform the build process. We assume that you have followed Ant's installation instructions and have it properly installed. It's not difficult, and I think that you will find it an excellent addition to your programmer's toolbox.

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

In each case below, it is assumed that you were successful in getting the distribution from CVS or as a nightly build, and with the latter, were successful in unpacking. Also, it is assumed that you are starting in the 'jakarta-velocity' directory, the root of the distribution tree. All directory references will be relative to 'jakarta-velocity'.

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

Change to the build directory (cd build). Then, to build the jar file, simply type:

build ディレクトリに移動してください (cd build)。 それから、jarファイルをビルドするには、単に以下のようにタイプしてください。

ant

Executing this script will create a bin directory within the Velocity distribution directory. The bin directory will contain the compiled class files (inside a classes directory) as well as a velocity-XX.jar file, where XX is the current version number. Be sure to update your classpath to include Velocity's .jar file.

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

Note that to build any of the specific build targets, as detailed in the developers guide, simply add the target name to the command line. For example, to build the Javadoc API documentation :

ビルドターゲット (開発者ガイドで詳述) の いずれかをビルドするには、コマンドラインでターゲット名を加えるだけです。 例えば、Javadoc API ドキュメトをビルドするには以下のようにします。

ant javadocs

Velocity should build 'out of the box', independent of your classpath. If you get an error building Velocity, try a different nightly build (as sometimes we make a mistake and the CVS at the time of the nightly snapshot isn't complete) or refresh from CVS (you might have gotten a CVS snapshot while a developer was checking things in.)

Velocity は、「独自に」、つまりクラスパスに依存せずにビルドすべきです。 Velocity のビルドでエラーが出た場合には、別の夜間ビルドを試してみるか (時にはミスがあって、夜間スナップショットの時点で必要なものが CVS にそろってない こともあります)、CVSから再取得してください (開発者によるチェックイン中にCVS スナップショットを取得したのかもしれません)。

If the problems persist, do not hesitate to ask the Velocity community via our mail lists. They can be found here. Please read and understand the the guidelines for participating in any Jakarta mail list.

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


Testing Your Installation − インストール後のテスト

The Velocity developers use an automated test facility, and it is included in the distribution. You can use it to make sure that all is well with your build of Velocity.

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

To run the test suite, simply use the build target test when you build :

テストスイートを実行するには、test というビルドターゲット を使ってビルドします。

ant test

If all is well, you should see output like :

うまくいけば、出力はこうなります。

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)

Note that the number of tests may vary from those shown above, but if you see 'OK' after the tests are run, all is well. Now it's time to use Velocity.

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



このドキュメントは、 熊坂祐二 、 高橋達男 、 野瀬直樹 が訳しました。
コメントがある場合は、 report@jajakarta.org までお願いします。
オリジナル英文 Copyright © 1999-2005, The Apache Software Foundation