geirm 01/04/01 20:57:06
Modified: xdocs getting-started.xml
docs getting-started.html
Log:
update, added some pointers to other materials.
Revision Changes Path
1.9 +30 -4 jakarta-velocity/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/getting-started.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- getting-started.xml 2001/03/19 02:52:24 1.8
+++ getting-started.xml 2001/04/02 03:57:06 1.9
@@ -12,9 +12,30 @@
<section name="Getting Started">
<p>
- This document provides developers with simple documentation for getting
- started with Velocity. For information about the overall structure of
- Velocity, please refer to the <a href="design.html">Design</a> document.
+ It's easy to get started with Velocity. The best places to start are
+
+ <ul>
+ <li>
+ The <a href="users-guide.html">User's Guide</a> which provides a good
+ overview of what Velocity templates are all about.
+ </li>
+ <li>
+ The <a href="developers-guide.html">Developers 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> a reference
+ guide for VTL, the Velocity Template Language.
+ </li>
+ <li>
+ The <a href="design.html">Design</a> document 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 the examples provided with the
distribution,
+ and the source code itself, which is included.
</p>
<p>
@@ -24,8 +45,13 @@
</section>
-<section name="View Detailed API Documentation">
+<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 are working on Unix/Linux and would like to create a full set
of detailed API documentation for Velocity, go to the
1.27 +30 -4 jakarta-velocity/docs/getting-started.html
Index: getting-started.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/getting-started.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- getting-started.html 2001/03/27 00:39:16 1.26
+++ getting-started.html 2001/04/02 03:57:06 1.27
@@ -109,9 +109,30 @@
<tr><td>
<blockquote>
<p>
- This document provides developers with simple documentation for getting
- started with Velocity. For information about the overall structure of
- Velocity, please refer to the <a href="design.html">Design</a> document.
+ It's easy to get started with Velocity. The best places to start are
+
+ <ul>
+ <li>
+ The <a href="users-guide.html">User's Guide</a> which provides a good
+ overview of what Velocity templates are all about.
+ </li>
+ <li>
+ The <a href="developers-guide.html">Developers 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> a reference
+ guide for VTL, the Velocity Template Language.
+ </li>
+ <li>
+ The <a href="design.html">Design</a> document 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 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
@@ -123,12 +144,17 @@
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="View Detailed API Documentation"><strong>View Detailed API
Documentation</strong></a>
+ <a name="API Documentation"><strong>API Documentation</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<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 are working on Unix/Linux and would like to create a full set
of detailed API documentation for Velocity, go to the
<code>build</code> directory and run the following script.
