<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- start the processing --> <!-- ====================================================================== --> <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! --> <!-- Main Page Section --> <!-- ====================================================================== --> <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/> <meta name="author" value="Velocity Documentation Team"> <meta name="email" value="dev@velocity.apache.org"> <title>Velocity - Velocity</title> <link rel="stylesheet" href="./site.css" type="text/css"> </head> <body> <div id="container"> <div id="header"> <div id="logo1"> <a href="http://velocity.apache.org"><img src="./images/velocity_project_wide.png" border="0"/></a> </div> <div id="logo2"> <a href="http://velocity.apache.org/"><img src="./images/velocity-logo.png" alt="Velocity" border="0"/></a> </div> </div> <div id="menu"> <!-- ============================================================ --> <div class="menusection"> <span class="menuheader">Velocity</span> <ul> <li> <a href="./index.html">General</a> </li> <li> <a href="./overview.html">Overview</a> </li> <li> <a href="./getting-started.html">Getting Started</a> </li> <li> <a href="./webapps.html">Web Applications</a> </li> <li> <a href="http://velocity.apache.org/download.cgi">Download</a> </li> <li> <a href="http://wiki.apache.org/velocity/VelocityFAQ">FAQ (Wiki)</a> </li> </ul> </div> <div class="menusection"> <span class="menuheader">Docs</span> <ul> <li> <a href="./user-guide.html">User Guide</a> </li> <li> <a href="./developer-guide.html">Developer Guide</a> </li> <li> <a href="./vtl-reference-guide.html">VTL Reference</a> </li> <li> <a href="./glossary.html">Glossary</a> </li> </ul> </div> <div class="menusection"> <span class="menuheader">Developers</span> <ul> <li> <a href="./../LICENSE">License</a> </li> <li> <a href="./api/index.html">Javadoc</a> </li> <li> <a href="http://velocity.apache.org/engine/devel/changes-report.html">Changes</a> </li> <li> <a href="http://velocity.apache.org/engine/devel/jira-report.html">Resolved Issues</a> </li> <li> <a href="./jar-dependencies.html">Dependencies</a> </li> <li> <a href="http://svn.apache.org/viewvc/velocity/engine/trunk/">Source Code Repository</a> </li> <li> <a href="./build.html">Building from Source</a> </li> </ul> </div> <div class="menusection"> <span class="menuheader">Community</span> <ul> <li> <a href="http://wiki.apache.org/velocity/">Wiki</a> </li> <li> <a href="http://velocity.apache.org/news.html">Recent News</a> </li> <li> <a href="http://wiki.apache.org/velocity/PoweredByVelocity">Powered By Velocity</a> </li> <li> <a href="http://wiki.apache.org/velocity/VelocityEditors">IDE/Editor Plugins</a> </li> <li> <a href="http://wiki.apache.org/velocity/PublishedArticlesAndBooks">Articles and Books</a> </li> <li> <a href="http://wiki.apache.org/velocity/GetInvolved">Get Involved</a> </li> <li> <a href="http://velocity.apache.org/contact.html">Mailing Lists</a> </li> </ul> </div> <div class="menusection"> <span class="menuheader">Velocity Development</span> <ul> <li> <a href="http://wiki.apache.org/velocity/RoadMap">Road Map</a> </li> <li> <a href="http://wiki.apache.org/velocity/CodeStandards">Coding Standards</a> </li> <li> <a href="http://wiki.apache.org/velocity/DocumentationGuidelines">Documentation Guidelines</a> </li> <li> <a href="https://issues.apache.org/jira/browse/VELOCITY">Issues</a> </li> <li> <a href="http://velocity.apache.org/who-we-are.html">Who we are</a> </li> </ul> </div> <div class="menusection"> <span class="menuheader">Translations</span> <ul> <li> <a href="http://www.jajakarta.org/velocity/">Site (Japanese)</a> </li> <li> <a href="./translations/user-guide_fi.html">User's Guide (Finnish)</a> </li> <li> <a href="./translations/user-guide_fr.html">User's Guide (French)</a> </li> <li> <a href="./translations/user-guide_es.html">User's Guide (Spanish)</a> </li> </ul> </div> </div> <div id="body"> <a name="WhatisVelocity?"></a> <h1>What is Velocity?</h1> <div class="subsection"> <p> Velocity is a Java-based template engine. It permits anyone to use a simple yet powerful template language to reference objects defined in Java code. </p> <p> When Velocity is used for web development, Web designers can work in parallel with Java programmers to develop web sites according to the Model-View-Controller (MVC) model, meaning that web page designers can focus solely on creating a site that looks good, and programmers can focus solely on writing top-notch code. Velocity separates Java code from the web pages, making the web site more maintainable over its lifespan and providing a viable alternative to <a href="http://java.sun.com/products/jsp/">Java Server Pages</a> (JSPs) or <a href="http://www.php.net/">PHP</a>. </p> <p> Velocity's capabilities reach well beyond the realm of the web; for example, it can be used to generate SQL, PostScript and XML (see <a href="anakia.html">Anakia</a> for more information on XML transformations) from templates. It can be used either as a standalone utility for generating source code and reports, or as an integrated component of other systems. For instance, Velocity provides template services for the <a href="http://jakarta.apache.org/turbine/">Turbine</a> web application framework, together resulting in a view engine facilitating development of web applications according to a true MVC model. </p> </div> <a name="WheredoIgetreleases?"></a> <h1>Where do I get releases?</h1> <div class="subsection"> <p> The current stable release version is version 1.7. </p> <p> The release distribution is available as a combined source/binary distribution in <code>tar.gz</code> and <code>zip</code> formats, and can be downloaded through the <a href="http://velocity.apache.org/download.cgi"> Apache Mirror system</a>. </p> <p> The Velocity jars are also available through the <a href="http://repo1.maven.org/maven2/org/apache/velocity/">central Maven repository</a>. </p> <p> Older releases are archived at the <a href="http://archive.apache.org/dist/velocity/engine/"> Apache Velocity archives</a>. </p> </div> <a name="WheredoIgetnightlysnapshots?"></a> <h1>Where do I get nightly snapshots?</h1> <div class="subsection"> <p> Nightly snapshots of the Velocity subversion source code tree can be found on our <a href="http://vc.apache.org/snapshots/velocity/">nightly snapshot site</a>. </p> <p><b>Caveat!</b> These snapshots are generated automatically from the project source code repository. As this is our live development workspace, there are no guarantees as to what you will find there, although we do our best to maintain a buildable source tree. If you are looking for the stable supported release, please use the current release of Velocity. </p> <p><b>Please be aware that these snapshots are not official releases of Apache Velocity software. They are provided for developer convenience only!</b></p> <p> If you are willing to risk getting dirty, we invite you to try the nightly snapshot to see the current state of affairs. (and help out!) <a href="http://www.apache.org/dev/version-control.html">Public Subversion access</a> is also available. </p> </div> <a name="HowdoIcontribute,givefeedback,fixbugsandsoon?"></a> <h1>How do I contribute, give feedback, fix bugs and so on?</h1> <div class="subsection"> <p> The Velocity project appreciates any contributions, including documentation help, source code and feedback. Suggested changes should come in the form of source code and/or feedback. </p> <ul> <li> Report bugs, ask questions, and help new users on the <a href="http://velocity.apache.org/contact.html"> Velocity mailing lists</a> . </li> <li> There's a list of issues waiting to be addressed in <a href="https://issues.apache.org/jira/browse/VELOCITY">our bug tracker</a> . </li> <li> <a href="http://wiki.apache.org/velocity/FrontPage"> Our Wiki</a> has a large collection of community written content. Add your own article or contribute to the FAQ! </li> <li> Read-only access to the Subversion repository is available both <a href="http://svn.apache.org/repos/asf/velocity/engine/trunk/"> online</a> and with a <a href="http://www.apache.org/dev/version-control.html"> Subversion client</a> . </li> </ul> </div> </div> <div id="footer"> Copyright © 1999-2007, <a href="http://www.apache.org/">The Apache Software Foundation</a>. </div> </div> </body> </html> <!-- end the processing -->