<!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 Getting Started</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="GettingStarted"></a>
<h1>Getting Started</h1>
<div class="subsection">
<p>
Velocity is easy to use! A quick way to get started is to skim the
references below, then look at the examples and source provided in the
distribution. <i>For developers writing web-based applications, the Web
Application Guide is highly recommended!</i>
<ul>
<li><a href="user-guide.html">User's Guide</a> - explains how to write Velocity templates
</li>
<li><a href="developer-guide.html">Developer's Guide</a> - explains how to use Velocity inside Java programs
</li>
<li><a href="vtl-reference-guide.html">VTL Reference</a> - concise syntax for Velocity Template Language (VTL)
</li>
<li><a href="webapps.html">Web Application Guide</a> - web-based application techniques and
VelocityViewServlet tutorial
</li>
</ul>
The best place to start is with the examples provided in the distribution,
and with the source code itself, which is included.
</p>
</div>
<a name="DownloadingVelocity"></a>
<h1>Downloading Velocity</h1>
<div class="subsection">
<p>
You can download the latest release version of
<a href="http://velocity.apache.org/download.cgi#engine">Velocity</a>
or <a href="http://velocity.apache.org/download.cgi#tools">Velocity Tools</a>
from the main Apache Velocity download site. For Velocity itself, source is included with the binary download.
</p>
<p>
If you want to download the latest source, you can do so via the Subversion (svn)
source control system, or download a complete
<a href="http://vc.apache.org/snapshots/velocity/">nightly snapshot.</a>
</p>
<p>
Instructions for building Velocity from source can be found in the
<a href="build.html">Build</a> document.
</p>
</div>
<a name="APIDocumentation"></a>
<h1>API Documentation</h1>
<div class="subsection">
<p>
Our API documentation is available <a href="http://velocity.apache.org/engine/devel/apidocs/">online</a>,
<a href="api/index.html">as part of the distribution package</a>, and of course, you can generate it
yourself from the included source code.
</p>
<p>
If you would like to create a full set
of detailed API documentation for Velocity, go to the
<code>build</code> directory and run:
</p>
<div class="source">
ant javadocs
</pre></div>
<p>
The docs will be found in the <code>/bin/apidocs/</code> directory.
</p>
<p>
<b>Note:</b> Velocity uses the <a href="http://ant.apache.org/">Apache Ant</a>
build tool for all code and documentation generation, so you will need to have it
installed. Velocity requires at least Apache Ant 1.7.
</p>
</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 -->
