The Jakarta Project < Velocity Tools - Library >

Velocity Tools

Generic Tools

Tool Documentation

Other Subprojects

Overview
       

GenericTools contain a collection of reusable and well documented tools and utility classes of general interest to Velocity users...

Emphasis is 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.

We are interested in Designer and Developer feedback on the format.

Contributions are welcome, see below for more details.

Tools:

DateTool
A tool for manipulating and formating dates.
MathTool
A tool for performing floating point math.
IteratorTool
A convenience tool to use with #foreach loops. It wraps a list to let the designer specify a condition to terminate the loop, and reuse the same list in different loops.
RenderTool
A tool to evaluate and render arbitrary strings of VTL (Velocity Template Language).

Utilities:

CommonsLogLogSystem
An implementation of Velocity's LogSystem interface that redirects log output to a Commons-Logging Log instance.
LogSystemCommonsLog
An implementation of Commons-Logging's Log interface that redirects log output to Velocity's LogSystem.

Contributions
       

We welcome your contributions to this library. 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.

Checklist for Contributions

  • Velocity coding conventions
  • JavaDoc included (the more detailed the better)
  • Examples included (in JavaDoc or as stand-alone template example)

Copyright © 1999-2003, Apache Software Foundation