The Jakarta Project < Velocity Tools >

Velocity

Velocity Tools

Sub-projects

Overview
       

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

VelocityView
       

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

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.

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


Generic Tools
       

Generic Tools 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).


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.

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


Example Applications
       

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.


Download
       

Releases

Velocity Tools 1.0 has been released and is available here.

Source Code

Nightly snapshots of the project source are available as binaries here.


CVS Repository
       

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

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

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


Wanna help?
       

This project is still young and has a growing user base. With the publicity of this first release, we expect the growth to increase significantly. We would like to encourage interested developers to evaluate the project and send feedback to the velocity-user or velocity-dev mailing list.

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.

A few good places to get started include:

  • Documentation (patches for the site or additions to the Wiki)
  • Improving the example apps
  • Support for Struts 1.1 features
Other project goals can be found in the project STATUS file.


Copyright © 1999-2002, Apache Software Foundation