Google GitGoogle Git
Sign in
apache/velocity-engine

Mirror of Apache Velocity Engine

Mirrored from https://github.com/apache/velocity-engine.git
Clone this repo:

Branches

More...

Tags

More...
  1. 6f6290c Start 2.6-SNAPSHOT (reset <scm><tag>=HEAD) by Claude Brisson · 4 weeks ago master
  2. e6c61ba Release 2.5: set versions to 2.5 and <scm><tag>=2.5 by Claude Brisson · 4 weeks ago 2.5-RC2
  3. f1473d5 Minor tweaks to the release script by Claude Brisson · 4 weeks ago
  4. 88140ef VELOCITY-1000 - InvalidReferenceEventHandler.invalidSetMethod() now sends the whole invalid LHS reference, not jusst its root by Claude Brisson · 4 weeks ago
  5. cf5384d VELOCITY-999 - SecureUberspector now honours the configured type conversion handler by Claude Brisson · 4 weeks ago

Title: Apache Velocity Engine

Apache Velocity

Welcome to Apache Velocity Engine! Apache Velocity is a general purpose template engine written in Java. For more information about Velocity, please look at the HTML documentation on the Velocity web site.

Here's a description of the top level directories:

velocity-engine-core/       The Velocity Engine core module
velocity-engine-examples/   Several simple examples
velocity-engine-scripting/  JSR-223 implementation for Velocity scripting
spring-velocity-support     Velocity Engine factory bean for current Spring (6.x/7.x, Java 17)
spring5-velocity-support    Velocity Engine factory bean for legacy Spring 5.x (Java 8)
src/                        Source for parent modules, mainly changelog

Apache Velocity requires at least Java 8 to run.

CUSTOMIZING THE PARSER

It is possible to build a custom parser, to change some of the characters used by the VTL syntax: *, @ and #.

Let's say you want to generate Markdown, where # starts a heading: you can for instance build your own parser which will use the % character as directives prefix instead of #.

The $ character can also be changed, but this is deprecated since 2.5: the next major version does not allow it.

TRYING THE EXAMPLES

After building Velocity, you can also build the examples that are included with the Velocity distribution. These examples show how to use Velocity in your Java applications.

For more information, please see the examples README in the velocity-engine-examples directory.

  • The Apache Velocity Team