The Jakarta Project < Velocity Tools >

Velocity

Velocity Tools

サブプロジェクト

概要
       

Velocity Tools は Velocity テンプレートエンジンを使用して、 Web/非Web 両方のアプリケーションを作成するのに役立つツールや、 インフラを作成することをゴールとする Velocity のサブプロジェクトの集まりです。

GenericTools
       

Generic Tools は、 Velocity コンテキスト内に格納できる、再利用が可能な ドキュメント付きのツール群です。 ツールとは Velocity エンジンから利用できる、 様々な処理を行うことのできるシンプルなクラスです。 ほとんどのツールは自動管理されたツールボックスと一緒に利用するように最適化されています (VelocityViewServlet 参照)。


VelocityView
       

VelocityViewには、 Web アプリケーションでテンプレートの表示処理を行うスタンドアロンのサーブレット (VelocityViewServlet) があります。

また、 "ビューツール" を自動的に生成し、 データをテンプレートへ提供する Toolbox Manager も含んでいます。 public メソッドをもつクラスであれば、 ツールとしてテンプレート内で使用することが可能です。

VelocityLayoutServlet は VelocityViewServlet を拡張したもので、 汎用的なレイアウトテンプレートの中に、 スクリーンを表示することができます。


VelocityStruts
       

VelocityStruts は、 Velocity テンプレートエンジンを Jakarta Struts フレームワーク上に構築された Web アプリケーションのビューレイヤとして使うときに利用するツールを集めたものです。

これは VelocityViewServlet と、 Velocity と Struts との統合を容易にする追加ツール群を利用して実現しています。 また、いくつかのサンプルアプリケーションも含んでいます。


サンプルアプリケーション
       

現在、いくつかのサンプルアプリケーションがあり、 そのひとつは Velocity を Struts のビューテクノロジとして使用する方法を示すものです。 このサンプルでは、比較のために Velocity と JSP の両方をビューとして使用しています。 また、言語の地域化のためのリソースバンドルの使い方も含まれています。 その他 VelocityLayoutServlet の使い方と、 最小構成の "シンプルな" アプリケーションの例が含まれています。


ドキュメント
       

テンプレートデザイナのためのツールドキュメントを提供することを重要視していました。 これを実現するために、テンプレートデザイナに関係する全ての情報を網羅するドキュメント形式が定義されました。 これは、通常の Javadoc に加えて提供されます。 これによって、私たちがいつも Velocity に求めている事− "テンプレートデザイナの仕事とソフトウェア開発者の仕事を分離せよ" −を達成する手助けになるはずです。 新しいドキュメント形式については、Struts の MessageTool が良い例となっています。

更新情報: この形式の見栄えと可読性を重宝すると同時に、 私たちは現在その使用から遠のいています。 一番の理由は、開発者にとってメンテナンスしにくいからです。 (i.e. 誰も余分な作業をするほどの意欲がないのです。) もしこの形式に価値があると判断し、様々なツールのドキュメントを作成し、 メンテナンスしたいと思いましたら、参加するための詳細について 下記 を参照して下さい。 当面は、各々のツールのjavadocの改善と、 サブプロジェクトのドキュメントの見直しを努力します。


ダウンロード
       

リリース

VelocityTools 1.1 がリリースされており、 ソース または バイナリ の形式で入手可能です。


CVS リポジトリ
       

Velocity Tools プロジェクトの全てのコードは jakarta-velocity-tools CVSリポジトリで管理されています。

Web ブラウザ: http://cvs.apache.org/viewcvs/jakarta-velocity-tools/

CVS クライアント: http://jakarta.apache.org/site/cvsindex.html.


手伝いたい?
       

私たちは興味のある開発者に対して、ソフトウェアを評価し、 velocity-user や velocity-dev メーリングリストへフィードバックをしてくれることを奨励します。

このプロジェクトの開発を進めることに興味を持ち、 熱心な活動と手助けを行ってくれることを特に期待しています。 パッチはメーリングリストへ送るか、 bugzilla のチケットとして添付してください。 Wiki は議論と開発のアイデアを展開するのにちょうど良いでしょう。

手始めとしてちょうどよいものとしては以下のものがあります:

  • ドキュメント (サイトのドキュメントへのパッチ、もしくはWikiへ追加する)
  • サンプルアプリケーションの改良
  • VelocimacroLibrariesへの提供
その他のプロジェクトのゴールや提案は、プロジェクトの STATUS ファイルにあります。


[訳注: この文書は Shinobu Kawai 木村 貴由 が翻訳しました。 日本語訳に対するコメントがあれば、report@jajakarta.orgに送って下さい。]
Copyright © 1999-2003, Apache Software Foundation