1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
<?xml version="1.0"?>
<!--
Copyright 2000-2004 The Apache Software Foundation
Licensed 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.
-->
<document>
<properties>
<title>Velocity Getting Started</title>
<author email="jvanzyl@zenplex.com">Velocity Documentation Team</author>
</properties>
<body>
<section name="Getting Started">
<p>
It's easy to get started with Velocity. The best places to start are
<ul>
<li>
The <a href="user-guide.html">User's Guide</a>, which provides a good
overview of what Velocity templates are all about.
</li>
<li>
The <a href="developer-guide.html">Developer's Guide</a>, which provides
a good reference and discussion of incorporating Velocity into your Java
programs and servlets.
</li>
<li>
The <a href="vtl-reference-guide.html">VTL Reference Guide</a>, which is a reference
guide for VTL, the Velocity Template Language.
</li>
<li>
The <a href="design.html">Design</a> document, which provides a high-level overview
of the how Velocity works, and why it's important.
</li>
</ul>
And of course, the best place to start is with the examples provided with the distribution,
and the source code itself, which is included.
</p>
<p>
Instructions for downloading and installing Velocity can be found on the
<a href="install.html">Install</a> document.
</p>
</section>
<section name="API Documentation">
<p>
Our API documentation is available <a href="api/index.html">online</a>,
as part of the distribution package, and of course, you can generate it
yourself from the included sources.
</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>
<source><![CDATA[
ant javadocs
]]></source>
<p>
The docs will be found in the <code>/docs/apidocs/</code> directory.
</p>
<p>
<b>Note:</b> Velocity uses the <a href="http://jakarta.apache.org/ant/">Jakarta Ant</a>
build tool for all code and documentation generation, so you will need to have it
installed. We strongly endorse this wonderful tool for any Java developer.
</p>
</section>
</body>
</document>
|
