The Jakarta Project < Velocity Tools >

Velocity

Velocity Tools

サブプロジェクト

概要
       

VelocityTools is a collection of Velocity subprojects with a common goal of creating tools and infrastructure for building both web and non-web applications using the Velocity template engine.

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

GenericTools
       

GenericTools is a group of reuseable and documented tools that can be added to a Velocity context. A tool is simply a class which can perform various tasks when made available to the Velocity engine. Most tools are optimized for use with an automatically managed toolbox (see VelocityViewServlet).

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


VelocityView
       

VelocityView contains a standalone servlet (VelocityViewServlet) which can render templates for web applications.

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

Also included is a Toolbox Manager which can automatically make "view tools" and data available to the templates. Any class with public methods can be used as a tool in the template.

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

VelocityLayoutServlet is an extension of the basic VelocityViewServlet that can render screen content into common layout templates.

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


VelocityStruts
       

VelocityStruts is a set of tools for using the Velocity template engine as the view layer for a web application built upon the Jakarta Struts framework.

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

This work leverages the VelocityViewServlet and additional tools which make it easy to integrate the Velocity with Struts. Several example hybrid applications are included.

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


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

Several example applications are currently available, including one to demonstrate the use of Velocity as a view technology for Struts. The example utilizes both Velocity and JSP files for the view in parallel so that they can be compared easily. Also, resources bundle usage for language localization is demonstrated there. Other examples include a demonstration of the use of the VelocityLayoutServlet and a minimal "simple" application.

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


ドキュメント
       

Emphasis is was being put on providing tool documentation that is suitable for template designers. To achive this goal, a documentation format has been defined that captures all information relevant to the template designer. It is being supplied in addition to the customary Javadoc. This should help to achieve what we always claim for Velocity: "Decouple the work of template designers from the work of software developers". Look at the Struts MessageTool for a good example of the new documentation format.

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

Update: While we value the look and readability of this format, we are presently drifting away from the use of it. The primary reason for this is that the developers have found it difficult to maintain (i.e. no one has been motivated enough to put in the extra work). If you feel this documentation format is valuable and wish to help us create and maintain it for the various individual tools, please see below for more details on getting involved. Meanwhile, we'll be putting effort into improving javadoc for individual tools and overview documents for the sub-projects.

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


ダウンロード
       

Releases

リリース

VelocityTools 1.1 is now available in source or binary form.

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


CVS リポジトリ
       

All VelocityTools project code is maintained in the CVS repository jakarta-velocity-tools.

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

Web Browser: http://cvs.apache.org/viewcvs/jakarta-velocity-tools/

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

CVS Client: http://jakarta.apache.org/site/cvsindex.html.

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


手伝いたい?
       

We encourage interested developers to evaluate the project and send feedback to the velocity-user or velocity-dev mailing list.

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

Those interested in furthering the development of this project are especially welcome to jump in and help out. Patches can be sent to the mailing list or attached to a bugzilla ticket. The Wiki can also be a good place to discuss and develop ideas.

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

A few good places to get started include:

  • Documentation (patches for the site or additions to the Wiki)
  • Improving the example apps
  • Contributing to the VelocimacroLibraries
Other project goals and proposals can be found in the project STATUS file.

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

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


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