nbubna 2003/03/08 11:59:56
Modified: . README.txt
Log:
bring this pretty much up to date
Revision Changes Path
1.8 +43 -17 jakarta-velocity-tools/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/README.txt,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- README.txt 23 Jun 2002 09:45:16 -0000 1.7
+++ README.txt 8 Mar 2003 19:59:55 -0000 1.8
@@ -6,23 +6,23 @@
The VelocityTools project contains three subprojects:
-VelocityServlet
+VelocityStruts
- A general-purpose servlet for rendering Velocity templates.
- There is no controller functionality - it's akin to the
- JspServlet. It includes toolbox support. See view/README.txt
- for more information.
+ Includes tools specific to integrating Velocity and Struts. This
+ package sits on top of (requires) the VelocityView package.
-VelocityLibrary
+VelocityView
- A collection of general purpose view tools. See
- library/REAMDE.txt for more information.
+ Package containing the VelocityViewServlet for rendering Velocity
+ templates. There is no controller functionality - it's akin to the
+ JspServlet. It includes toolbox support. (Also contains a
+ VelocityLayoutServlet to support more advanced template rendering.)
+
-VelocityStruts
+Generic tools
- Tools specific to integrating Velocity and Struts. See
- struts/README.txt for more information. There are several
- nice application examples included.
+ A collection of general purpose tools that may be used independently of
+ the VelocityView or VelocityStruts package (but is included with both).
@@ -41,9 +41,34 @@
> ant clean
+By default, the project will build the VelocityStruts jar, javadoc and
+project documentation.
+
+To build only the VelocityStruts jar (which includes both VelocityView classes
+and the generic tools), execute:
+
+> ant jar.struts
+
+To build only the VelocityView jar (which includes the generic tools), execute:
+
+> ant jar.view
+
+To build only the generic tools jar, execute:
+
+> ant jar.generic
+
+To build the simple example for VelocityView, execute:
+
+> ant example.simple
+
+To build the VelocityStruts example, execute:
+
+> ant example.struts
+
+
Please note:
-- During the build process DVSL emits several of the following error
+- During the documentation build process DVSL emits several of the following error
messages. They can be ingnored. A bug report has be filed.
[dvsl] [error] ResourceManager: unable to find resource 'VM_global_library.vm' in
any resource loader.
@@ -53,11 +78,12 @@
because then the software wouldn't compile with JDK 1.3.1 anymore.
The build process has been tested with JDK 1.3.1 and JDK 1.4.0. The
-included example applications have been tested with Tomcat 4.0.4 and
-Resin 2.1.0.
+included example applications have been tested with Tomcat 4.0.4,
+Tomcat 4.1.18, and Resin 2.1.0.
If you observe any problems with the build process, please report this
-to the Velocity users mailing list, [EMAIL PROTECTED]
+to the Velocity users mailing list, [EMAIL PROTECTED], and
+put [veltools] in the subject line.
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
