Title: Apache Velocity Tools
Welcome to the VelocityTools projects. This is a subproject of the Apache Velocity project hosted at http://velocity.apache.org/
The VelocityTools project contains several subprojects:
velocity-tools-generic/ A collection of general purpose tools velocity-tools-view/ Tools servlets and filters for use in a webapp velocity-tools-jsp/ Tools for a J2EE JSP context velocity-tools-examples/ velocity-tools-examples-simple/ Simple examples velocity-tools-examples-showcase/ A full webapp demonstrating tools
Apache Velocity Tools will run with any Java runtime engine v1.7 or greater.
Building from source requires Java development kit v1.7 or greater and Maven 3 (3.0.5+).
Maven should fetch all needed dependencies for compile ant run time, which are:
Plus the following ones, needed for the integrated tests:
Release with the same major number are intended to be drop-in replacements. However, in most cases the versions of dependency jars must be adjusted because newer versions of Velocity might require updates.
tools autoloading turned off by default With velocity-tools-view in a webapp context, if you want the default tools loaded without explicitely loading them yourslef, you will have to enable autoloading in your
<context-param> <param-name>org.apache.velocity.tools.loadDefaults</param-name> <param-value>true</param-value> </context-param>
(or the same with
<init-param> for a single servlet).
the WebappResourceLoader, as other Engine loaders, now returns a Reader rather than an InputStream
the unmaintained Struts tools have been dropped
there are several new tools: LogTool, JsonTool, CollectionTool
several tools became deprecated: AlternateTool, SortTool, ConversionTool (conversion methods are now located in DateTool and NumberTool)
You can consult the full list of changes
Please refer to Tools 2.0 upgrading instructions.
In order to use the latest version of Apache Velocity Tools, you may want to build it.
Building is easy. All components necessary to build are included or get downloaded from the internet during the build, except for the Java SDK and the Maven build tool.
IMPORTANT As the Apache Velocity Tools build process wants to download a number of jars from the internet, you must be online when you are building for the first time.
To build the Velocity Tools' jars, just run maven using the command:
This will create a
target/ directory containing the Velocity tools
.jar file in each sub-module directory.
We welcome your feedback to firstname.lastname@example.org.