You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by si...@apache.org on 2002/06/23 11:45:16 UTC
cvs commit: jakarta-velocity-tools/view/examples/simple/WEB-INF web.xml
sidler 2002/06/23 02:45:16
Modified: . README.txt build.xml
struts README.txt build.xml
struts/examples/struts build.xml index.html
struts/examples/struts/WEB-INF/build-lib README.txt
tools README.txt build.xml
view README.txt build.xml
view/examples/simple build.xml
view/examples/simple/WEB-INF web.xml
Log:
Improved build process. There is now a "master" build script in the root dir
that builds everything, including all subprojects, documentation, example
applications, etc. The "master" build script calls build scripts of each sub-
project to do it job. Tested build with JDK1.3.1 and JDK 1.4.0. Tested examples
with Tomcat and Resin. This should make it easier for people to get up and
started. Adapted README files to the changes.
Revision Changes Path
1.7 +29 -8 jakarta-velocity-tools/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/README.txt,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- README.txt 16 Apr 2002 14:09:06 -0000 1.6
+++ README.txt 23 Jun 2002 09:45:16 -0000 1.7
@@ -1,8 +1,9 @@
R E A D M E
===========
-Welcome to the VelocityTools projects. This project is an umbrella
-for three subprojects:
+Welcome to the VelocityTools projects. This is a subproject of the
+Apache Velocity project hosted at http://jakarta.apache.org/velocity/
+The VelocityTools project contains three subprojects:
VelocityServlet
@@ -25,21 +26,40 @@
-
Build Instructions
------------------
-Building the project requires ant 1.4.1 or higher. To build the entire
-project, including the subprojects, documentation, examples, type:
+Building the project requires JDK 1.3.1 or JDK 1.4.0 and ant 1.4.1
+or higher. There is an ant script included that builds the entire
+project, including all three subprojects, documentation, application
+examples, etc. To build the project, start ant in the root directory
+of the project:
> ant
-To return to the original virgin state, type:
+To return the project to the original virgin state, execute:
> ant clean
+Please note:
+
+- During the 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.
+
+- When compiling with JDK 1.4.0 there are two deprecation warnings
+ involving java.net.URLEncoder. They can't be fixed at the moment,
+ 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.
+
+If you observe any problems with the build process, please report this
+to the Velocity users mailing list, velocity-user@jakarta.apache.org.
+
-
Documentation
-------------
@@ -50,9 +70,10 @@
-
Feedback
--------
We welcome your feedback to velocity-user@jakarta.apache.org.
+
+$Revision$ $Date$
1.7 +17 -14 jakarta-velocity-tools/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/build.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- build.xml 20 Apr 2002 16:57:14 -0000 1.6
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.7
@@ -14,17 +14,11 @@
<!-- ========== Component Declarations ==================================== -->
<!-- The name of this component -->
- <property name="project.name" value="velocity-tools" />
+ <property name="project.name" value="VelocityTools" />
<!-- The title of this component -->
<property name="project.title" value="Velocity Tools Documentation"/>
- <!-- The current version number of this component -->
- <property name="project.version" value="0.1"/>
-
- <!-- The current version number of this component -->
- <property name="project.date" value="27-Mar-2002"/>
-
<!-- The base directory for compilation targets -->
<property name="build.home" value="${basedir}"/>
@@ -51,6 +45,15 @@
<fileset dir="${project.repository}">
<include name="**/*.jar"/>
</fileset>
+ <fileset dir="${basedir}/view/lib">
+ <include name="**/*.jar"/>
+ </fileset>
+ <fileset dir="${basedir}/struts/lib">
+ <include name="**/*.jar"/>
+ </fileset>
+ <fileset dir="${basedir}/tools/lib">
+ <include name="**/*.jar"/>
+ </fileset>
</path>
<!-- ========== Executable Targets ======================================== -->
@@ -61,9 +64,8 @@
<!-- ================================================================== -->
<target name="init">
<!-- Initialize and evaluate conditionals -->
- <echo message="-------- ${project.name} ${project.version} --------"/>
+ <echo message="-------- ${project.name} --------"/>
<filter token="name" value="${project.name}"/>
- <filter token="version" value="${project.version}"/>
</target>
<!-- ================================================================== -->
@@ -103,9 +105,7 @@
<ant dir="tools" target="clean" inheritAll="false"/>
<ant dir="struts" target="clean" inheritAll="false"/>
-
- <ant dir="struts/examples/struts" target="clean" inheritAll="false"/>
-
+
</target>
@@ -127,6 +127,9 @@
<!-- Build view package -->
<ant dir="view" target="all" inheritAll="false"/>
+ <!-- Build the Simple example -->
+ <!-- <ant dir="view/examples/simple" target="all" inheritAll="false"/> -->
+
</target>
@@ -152,7 +155,7 @@
<ant dir="struts" target="all" inheritAll="false"/>
<!-- Build VelocityStruts examples -->
- <ant dir="struts/examples/struts" target="all" inheritAll="false"/>
+ <!-- <ant dir="struts/examples/struts" target="all" inheritAll="false"/> -->
</target>
@@ -177,7 +180,7 @@
private="true"
version="true"
doctitle="<h1>${project.title}</h1>"
- windowtitle="${project.title} (Version ${project.version})"
+ windowtitle="${project.title}"
bottom="Copyright (c) 2002 Apache Software Foundation" >
<package name="org.apache.velocity.tools.*"/>
1.6 +40 -40 jakarta-velocity-tools/struts/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/README.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- README.txt 15 Apr 2002 18:30:27 -0000 1.5
+++ README.txt 23 Jun 2002 09:45:16 -0000 1.6
@@ -1,58 +1,52 @@
R E A D M E
===========
-This part of jakarta-velocity-tools is focused on Struts-Velocity
-integration using the VelocityViewServlet and other tools found
-in this project. Struts support in Velocity is provided through
-several view tools.
+This is the root directory of the VelocityStruts package. This
+package aims to make Velocity available as an alterative view
+technology for the Apache Struts Web application framework.
+Struts support in Velocity is provided through several view tools.
-This is an alpha version. We do not recommend that you build production
-systems based on this software at this stage. The API may still
-change. We will produce a beta version when we believe that the API
-is reasonably stable.
+This is an alpha version. The API may still change. We will produce
+a beta version when we believe that the API is reasonably stable.
-Prerequisites are:
-o Ant 1.4.1 or higher
-o JDK 1.3.1 or higher
-To build the package:
+Build Instructions
+------------------
-> ant
+See the README.txt file in the directory above the directory of
+this file.
-This compiles the package, generates a jar file in the same directory
-and sets up the examples.
+The build process generates a velocity-tools-struts-*.jar file in
+the directory where this README is located. This jar file contains
+the classes needed for Velocity support in Struts.
-The directory 'docs' contains reference documentation for the included
-view tools. More documentation will be added shortly. For now the
-best way to get a feel for the Struts Velocity integration is to look
-at the included examples.
+Documentation
+-------------
-Examples
---------
+After the project has been built, the directory 'docs' contains
+reference documentation for the included view tools and an incomplete
+draft of a user guide. More documentation will be added shortly. For
+now the best way to get a feel for the Struts Velocity integration is
+to look at the included application examples.
-Several Struts application examples have been included to demonstrate
-the use of Velocity templates with Struts.
-To run the examples you need:
-o ant 1.4.1 or higher to build a deployable version of the example
- applications (war file)
-o JDK 1.3.1 or higher
-o Tomcat 3.X, Tomcat 4.X or a comparable servlet runner to run the
- examples.
-
-To build a deployable version of the examples follow these steps:
-
-o Build the Struts package as outlined in the first section.
-o Change to directory examples/struts
-o Use ant to build a deployable version: > ant war
-
-This will generate a velstruts.war file in directory 'examples'.
-Deploy this .war file to the webapps directory of your servlet
-runner and restart. Now point a web browser at:
+Application Examples
+--------------------
+
+Several Struts application examples are included to demonstrate the
+use of Velocity templates with Struts.
+
+To run the examples you need Tomcat 4.X or a compatible servlet runner.
+
+The build process automatically generates a ready-to-deploy war archive
+file of the included application examples. The war file is located in
+the examples subdirectory. Deploy (copy) this .war file to the webapps
+directory of your servlet runner and restart. Now point a web browser
+at:
http://<server>:<port>/velstruts/
@@ -60,4 +54,10 @@
-Please send your feedback to velocity-user@jakarta.apache.org.
\ No newline at end of file
+Feedback
+--------
+
+We welcome your feedback to velocity-user@jakarta.apache.org.
+
+
+$Revision$ $Date$
1.12 +41 -19 jakarta-velocity-tools/struts/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/build.xml,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- build.xml 22 May 2002 08:23:17 -0000 1.11
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.12
@@ -9,7 +9,7 @@
<!-- ========== External Dependencies ===================================== -->
<!-- the local repository -->
- <property name="local.repository" value="${basedir}/lib" />
+ <property name="local.repository" value="${basedir}/lib" />
<property name="project.repository" value="${basedir}/../lib" />
<!-- ========== Component Declarations ==================================== -->
@@ -22,10 +22,10 @@
<property name="project.title" value=""/>
<!-- The current version number of this component -->
- <property name="project.version" value="0.8"/>
+ <property name="project.version" value="0.9"/>
- <!-- The current version number of this component -->
- <property name="project.date" value="29-Mar-2002"/>
+ <!-- The version's date -->
+ <property name="project.date" value="22-Jun-2002"/>
<!-- The base directory for compilation targets -->
<property name="build.home" value="${basedir}/target"/>
@@ -83,6 +83,7 @@
<filter token="version" value="${project.version}"/>
</target>
+
<!-- ================================================================== -->
<!-- P R E P A R E -->
<!-- ================================================================== -->
@@ -95,6 +96,7 @@
<mkdir dir="${build.home}/javadoc"/>
</target>
+
<!-- ================================================================== -->
<!-- S T A T I C -->
<!-- ================================================================== -->
@@ -106,6 +108,7 @@
</copy>
</target>
+
<!-- ================================================================== -->
<!-- C O M P I L E -->
<!-- ================================================================== -->
@@ -125,6 +128,7 @@
</target>
+
<!-- ================================================================== -->
<!-- C L E A N -->
<!-- ================================================================== -->
@@ -145,21 +149,22 @@
<fileset dir="${project.repository}" includes="${project.name}-*.jar"/>
</delete>
- <delete dir="${examples.home}/velstruts"/>
+ <delete>
+ <fileset dir="${basedir}" includes="**/*.bak"/>
+ </delete>
+ <!-- Clean examples -->
+ <delete dir="${examples.home}/velstruts"/>
+ <ant dir="examples/struts" target="clean" inheritAll="false"/>
<delete dir="${examples.home}/struts/doc/javadoc"/>
-
<delete>
- <fileset dir="${examples.home}/struts/WEB-INF/lib" includes="$velocity-tools-*.jar"/>
+ <fileset dir="${examples.home}/struts/WEB-INF/lib" includes="*.jar"/>
+ <fileset dir="${examples.home}/struts/WEB-INF/build-lib" includes="*.jar"/>
</delete>
-
<delete>
<fileset dir="${examples.home}" includes="*.war"/>
</delete>
- <delete>
- <fileset dir="${basedir}" includes="**/*.bak"/>
- </delete>
</target>
@@ -167,14 +172,14 @@
<!-- ================================================================== -->
<!-- A L L -->
<!-- ================================================================== -->
- <target name="all" depends="jar,install-jar,docs,javadocs,examples"
+ <target name="all" depends="install-jar,docs,javadocs,examples"
description="Build entire project"/>
<!-- ================================================================== -->
<!-- J A V A D O C S -->
<!-- ================================================================== -->
- <target name="javadocs" depends="compile"
+ <target name="javadocs" depends="static"
description="Create Javadoc documentation">
<javadoc sourcepath="${source.home}/java"
destdir="${build.home}/javadoc"
@@ -185,10 +190,9 @@
doctitle="<h1>${project.title}</h1>"
windowtitle="${project.title} (Version ${project.version})"
bottom="Copyright (c) 2002 Apache Software Foundation" >
-
<classpath refid="classpath"/>
-
</javadoc>
+
</target>
@@ -199,7 +203,8 @@
description="Package class as jar file into ${builddir}">
<jar jarfile="${project.name}-${project.version}.jar"
basedir="${build.home}/classes"
- manifest="${conf.home}/MANIFEST.MF"/>
+ manifest="${conf.home}/MANIFEST.MF"
+ excludes="**/*.html" />
</target>
@@ -256,8 +261,8 @@
<!-- ================================================================== -->
<!-- E X A M P L E S -->
<!-- ================================================================== -->
- <target name="examples" depends="jar,install-jar,docs,javadocs"
- description="Setup example application">
+ <target name="examples" depends="install-jar,docs,javadocs"
+ description="Setup example applications.">
<!-- Setup example applications -->
@@ -274,6 +279,19 @@
<copy todir="${examples.home}/struts/WEB-INF/lib" filtering="no">
<fileset dir="${project.repository}">
<include name="velocity-tools-*.jar"/>
+ <include name="commons-beanutils*.jar"/>
+ <include name="commons-collections*.jar"/>
+ <include name="commons-digester*.jar"/>
+ <include name="dom4j*.jar"/>
+ <include name="jdbc2_0-stdext*.jar"/>
+ <include name="velocity-dep*.jar"/>
+ <include name="struts*.jar"/>
+ </fileset>
+ </copy>
+
+ <copy todir="${examples.home}/struts/WEB-INF/build-lib" filtering="no">
+ <fileset dir="${project.repository}">
+ <include name="jakarta-servlet-api*.jar"/>
</fileset>
</copy>
@@ -282,6 +300,10 @@
<fileset dir="${build.home}/javadoc"/>
</copy>
+ <!-- Build VelocityStruts examples -->
+ <ant dir="examples/struts" target="all" inheritAll="false"/>
+
+
<!-- Fix problems with relative links first
Copy reference documentation
<copy todir="${examples.home}/struts/doc/">
@@ -315,7 +337,7 @@
<!-- I N S T A L L J A R -->
<!-- ================================================================== -->
<target name="install-jar" depends="jar"
- description="--> Installs .jar file in ${project.repository}">
+ description="Installs .jar file in ${project.repository}">
<copy todir="${project.repository}" filtering="no">
<fileset dir="${basedir}">
1.9 +5 -4 jakarta-velocity-tools/struts/examples/struts/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/build.xml,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- build.xml 16 Apr 2002 14:09:07 -0000 1.8
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.9
@@ -79,7 +79,7 @@
<!-- ================================================================== -->
<!-- A L L -->
<!-- ================================================================== -->
- <target name="all" depends="clean,init,compile,war"
+ <target name="all" depends="war"
description="Build entire example"/>
@@ -128,12 +128,13 @@
<!-- ================================================================== -->
<!-- W A R -->
<!-- ================================================================== -->
- <target name="war" depends="clean, compile"
+ <target name="war" depends="compile"
description="Generate a *.war file of the example application">
<!-- Generate .war file, name it velstruts.war -->
- <jar jarfile="${basedir}/../velstruts.war" basedir="${basedir}"/>
+ <jar jarfile="${basedir}/../velstruts.war"
+ basedir="${basedir}"
+ excludes="**/MANIFEST.MF"/>
</target>
-
</project>
1.8 +14 -10 jakarta-velocity-tools/struts/examples/struts/index.html
Index: index.html
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/index.html,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- index.html 15 Apr 2002 18:30:27 -0000 1.7
+++ index.html 23 Jun 2002 09:45:16 -0000 1.8
@@ -10,14 +10,14 @@
<td>
<h2><font color="#FFFFFF"><img src="doc/img/spacer.gif" width="520" height="1"><br>
Velocity for Struts</font></h2>
- <font color="#FFFFFF">Version 0.7, April 2. 2002</font></td>
+ <font color="#FFFFFF">Version 0.9, June 22. 2002</font></td>
<td align="right"> </td>
</tr>
</table>
-<p>This is an example web application demonstrating the integration of the
+<p>Velocity for Struts is a subproject of the <a href="http://jakarta.apache.org/velocity/">Apache Velocity</a> project. This is an example web application demonstrating the integration of the
<a href="http://jakarta.apache.org/struts/">Struts web application framework</a>
-with the <a href="http://jakarta.apache.org/velocity">Velocity template engine</a>.
+with the <a href="http://jakarta.apache.org/velocity/">Velocity template engine</a>.
</p>
@@ -35,10 +35,9 @@
<h5>Status</h5>
<p>The API has been redesigned completely and is now more complete and more
systematic. An early draft of several documentation pages is
-now available.</p>
-
-<p>This is an unrealeased work in progress. New versions will be announced
-on the Velocity mailing list and home page.</p>
+now available. Several projects are currently using the software. This is an
+unrealeased work in progress. New versions will be announced on the Velocity
+mailing list and home page.</p>
@@ -53,9 +52,9 @@
<h5>Documentation</h5>
+<p>This project is hosted at <a href="http://jakarta.apache.org/velocity/toolsubproject.html">http://jakarta.apache.org/velocity/toolsubproject.html</a>. There you find the latest news and instructions to download the software.</p>
<p>An early draft of the <a href="http://www.teamup.com/jakarta-velocity-tools/struts/docs/index.html">
-documentation</a> is available online. This is a work in progress but I
-guess it is better than no documentation at all.</p>
+documentation</a> is available online. This is a work in progress but I guess it is better than no documentation at all.</p>
@@ -64,13 +63,18 @@
<ul>
<li>Tomcat 4.01, Resin 2.1.0</li>
<li>Netscape 4.7, MS Explorer 5.5</li>
- <li>Java 2 Version 1.3.1, Standard Editon, with Java Hot Spot Server VM</li>
+ <li>JDK 1.3.1, JDK 1.4.0</li>
<li>Ant 1.4.1</li>
<li>Jakarta Struts 1.0.2 Binary Library Distribution </li>
<li>Jakarta Velocity 1.3 dev with dependencies</li>
<li>Jakarta Servlet API 4 (same as distributed with Tomcat 4)
</li>
</ul>
+
+
+<h5>Feedback</h5>
+<p>We really appreciated your feedback. Please send your feedback and questions to the Velocity Users Mailing List at <a href="mailto:velocity-user@jakarta.velocity.org">velocity-user@jakarta.apache.org</a>.</p>
+
</BODY>
</HTML>
1.2 +3 -3 jakarta-velocity-tools/struts/examples/struts/WEB-INF/build-lib/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/struts/examples/struts/WEB-INF/build-lib/README.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README.txt 16 Jan 2002 12:03:48 -0000 1.1
+++ README.txt 23 Jun 2002 09:45:16 -0000 1.2
@@ -1,5 +1,5 @@
-README
-======
+R E A D M E
+===========
-JARs in this directory are used only for the
+Libraries in this directory are used only for the
build process but not to run the application.
1.3 +18 -11 jakarta-velocity-tools/tools/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/README.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- README.txt 15 Apr 2002 18:30:28 -0000 1.2
+++ README.txt 23 Jun 2002 09:45:16 -0000 1.3
@@ -5,22 +5,29 @@
Most tools are optimized for use with an automatic toolbox manager.
-Build and JAR
--------------
-An ant script is provided to build and jar the package.
-> ant compile
-> ant jar
+Build Instructions
+------------------
+See the README.txt file in the directory above the directory of
+this file.
+
+The build process generates a velocity-tools-library-*.jar file in
+the directory where this README is located. This jar file contains
+the classes of all view tools in this package.
+
Documentation
-------------
-To generate the documentation for this package, call:
+After the project has been built, the 'docs' directory contains the
+available documentation of this package.
+
+
+
+Feedback
+--------
-> ant docs
+We welcome your feedback to velocity-user@jakarta.apache.org.
-Then look for the generated documentation in the 'docs' subdirectory.
-
-
-Please send your feedback to velocity-user@jakarta.apache.org.
\ No newline at end of file
+$Revision$ $Date$
1.7 +14 -11 jakarta-velocity-tools/tools/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/tools/build.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- build.xml 10 May 2002 05:42:17 -0000 1.6
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.7
@@ -10,7 +10,7 @@
<!-- ========== External Dependencies ===================================== -->
<!-- the local repository -->
- <property name="local.repository" value="${basedir}/lib" />
+ <!-- <property name="local.repository" value="${basedir}/lib" /> -->
<property name="project.repository" value="${basedir}/../lib" />
<!-- ========== Component Declarations ==================================== -->
@@ -23,10 +23,10 @@
<property name="project.title" value=""/>
<!-- The current version number of this component -->
- <property name="project.version" value="0.2"/>
+ <property name="project.version" value="0.3"/>
- <!-- The current version number of this component -->
- <property name="project.date" value="24-Mar-2002"/>
+ <!-- The version's date -->
+ <property name="project.date" value="22-Jun-2002"/>
<!-- The base directory for compilation targets -->
<property name="build.home" value="${basedir}/target"/>
@@ -60,9 +60,10 @@
<!-- Construct compile classpath -->
<path id="classpath">
- <fileset dir="${local.repository}">
- <include name="**/*.jar"/>
- </fileset>
+ <!-- <fileset dir="${local.repository}">
+ <include name="**/*.jar"/>
+ </fileset>
+ -->
<fileset dir="${project.repository}">
<include name="**/*.jar"/>
</fileset>
@@ -87,10 +88,10 @@
<target name="prepare" depends="init"
description="Prepare build directory">
<mkdir dir="${docs.dest}"/>
+ <mkdir dir="${docs.dest}/javadoc"/>
<mkdir dir="${build.home}"/>
<mkdir dir="${build.home}/classes"/>
<mkdir dir="${build.home}/conf"/>
- <mkdir dir="${build.home}/javadoc"/>
</target>
<!-- ================================================================== -->
@@ -108,7 +109,7 @@
<!-- ================================================================== -->
<!-- A L L -->
<!-- ================================================================== -->
- <target name="all" depends="jar,install-jar,docs,javadocs"
+ <target name="all" depends="install-jar,docs,javadocs"
description="Build entire project"/>
@@ -181,9 +182,10 @@
<package name="org.apache.velocity.tools.tools"/>
<package name="org.apache.velocity.tools.view.tools"/>
<package name="org.apache.velocity.tools.view.context"/>
+ <package name="org.apache.velocity.tools.view.servlet"/>
<group title="View Tools" packages="org.apache.velocity.tools.tools"/>
- <group title="View Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context"/>
+ <group title="View Tools Infrastructure" packages="org.apache.velocity.tools.view.tools:org.apache.velocity.tools.view.context:org.apache.velocity.tools.view.servlet"/>
<classpath refid="classpath"/>
@@ -197,7 +199,8 @@
<target name="jar" depends="compile">
<jar jarfile="${project.name}-${project.version}.jar"
basedir="${build.home}/classes"
- manifest="${conf.home}/MANIFEST.MF"/>
+ manifest="${conf.home}/MANIFEST.MF"
+ excludes="**/*.html" />
</target>
1.6 +36 -30 jakarta-velocity-tools/view/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/README.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- README.txt 22 May 2002 08:18:39 -0000 1.5
+++ README.txt 23 Jun 2002 09:45:16 -0000 1.6
@@ -1,17 +1,16 @@
R E A D M E
===========
-This package contains a standalone servlet that can be used for
-template rendering in Web applications. It offers automatic population
-of the Velocity context and automatic, configurable management of
-view tools, and I18N support. Other efforts within this package are
-the development of a toolbox manager and the definition of a set of
-interfaces for view tools, thereby enabling the efficient handling
-and reuse of view tools.
+This package contains a standalone servlet VelocityViewServlet that
+can be used for template rendering in Web applications. It is akin
+to the JSPServlet. It offers automatic population of the Velocity
+context and automatic, configurable management of view tools.
-Build Package
--------------
+
+Build Instructions
+------------------
+
An ant script is provided to build and jar the package. Prerequisites are:
o Ant 1.4.1 or higher
@@ -27,32 +26,39 @@
-Application Example
--------------------
+Documentation
+-------------
+After the project has been built, the directory 'docs' contains some
+minimal documentation. For now the best way to get a feel for the
+VelocityViewServlet and its capabilities is to look at the included
+application examples and the Javadoc.
-A simple application example has been included to demonstrate the use of the
-VelocityViewServlet with automatically loaded view tools.
-To run the example you need:
-o Ant 1.4.1 or higher
-o JDK 1.3.1 or higher
-o Tomcat 3.X, Tomcat 4.X or a comparable servlet runner to run the
- examples.
+Application Examples
+--------------------
-To build a deployable version of the example follow these steps:
+A simple application example has been included to demonstrate the use
+of the VelocityViewServlet with automatically loaded view tools.
-1) Build the View package as outlined in the first section
-2) Change to directory examples/simple
-3) Use ant to build a deployable version:
-
- > ant
-
-This generates a file simple.war file in directory 'examples'.
-Deploy this .war file to the webapps directory of your servlet
-runner and restart. Now point a web browser at:
+To run the examples you need Tomcat 4.X or a compatible servlet runner.
+
+The build process automatically generates a ready-to-deploy simple.war
+archive file of the included application example. The war file is
+located in the examples subdirectory. Deploy (copy) this simple.war file
+to the webapps directory of your servlet runner and restart. Now point
+a web browser at:
-http://<server>:<port>/simple/index.vm
+http://<server>:<port>/simple/
+to access the examples.
+
+
-Please send your feedback to velocity-user@jakarta.apache.org.
\ No newline at end of file
+Feedback
+--------
+
+We welcome your feedback to velocity-user@jakarta.apache.org.
+
+
+$Revision$ $Date$
1.14 +29 -15 jakarta-velocity-tools/view/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/build.xml,v
retrieving revision 1.13
retrieving revision 1.14
diff -u -r1.13 -r1.14
--- build.xml 22 May 2002 08:18:39 -0000 1.13
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.14
@@ -10,7 +10,7 @@
<!-- ========== External Dependencies ===================================== -->
<!-- the local repository -->
- <property name="local.repository" value="${basedir}/lib" />
+ <!-- <property name="local.repository" value="${basedir}/lib" /> -->
<property name="project.repository" value="${basedir}/../lib" />
@@ -23,7 +23,10 @@
<property name="project.title" value=""/>
<!-- The current version number of this component -->
- <property name="project.version" value="0.7"/>
+ <property name="project.version" value="0.8"/>
+
+ <!-- The version's date -->
+ <property name="project.date" value="22-Jun-2002"/>
<!-- The base directory for compilation targets -->
<property name="build.home" value="${basedir}/target"/>
@@ -60,9 +63,10 @@
<!-- Construct compile classpath -->
<path id="classpath">
- <fileset dir="${local.repository}">
- <include name="**/*.jar"/>
- </fileset>
+ <!-- <fileset dir="${local.repository}">
+ <include name="**/*.jar"/>
+ </fileset>
+ -->
<fileset dir="${project.repository}">
<include name="**/*.jar"/>
</fileset>
@@ -147,31 +151,33 @@
</delete>
<delete>
- <fileset dir="${examples.home}/simple/WEB-INF/lib" includes="velocity-tools-view*.jar"/>
+ <fileset dir="${basedir}" includes="**/*.bak"/>
</delete>
+ <!-- Clean example application -->
+ <ant dir="${examples.home}/simple" target="clean" inheritAll="false"/>
<delete>
- <fileset dir="${examples.home}" includes="*.war"/>
+ <fileset dir="${examples.home}/simple/WEB-INF/lib" includes="*.jar"/>
</delete>
-
<delete>
- <fileset dir="${basedir}" includes="**/*.bak"/>
+ <fileset dir="${examples.home}" includes="*.war"/>
</delete>
+
</target>
<!-- ================================================================== -->
<!-- A L L -->
<!-- ================================================================== -->
- <target name="all" depends="jar,install-jar,docs,javadocs,javadocs-velservlet,examples"
+ <target name="all" depends="install-jar,docs,javadocs,javadocs-velservlet,examples"
description="Build entire project"/>
<!-- ================================================================== -->
<!-- J A V A D O C S -->
<!-- ================================================================== -->
- <target name="javadocs" depends="compile"
+ <target name="javadocs" depends="static"
description="Create Javadoc documentation into ${build.home}/javadoc">
<javadoc sourcepath="${source.home}/java"
destdir="${build.home}/javadoc"
@@ -224,7 +230,9 @@
description="Package classes as jar into ${builddir}">
<jar jarfile="${project.name}-${project.version}.jar"
basedir="${build.home}/classes"
- manifest="${conf.home}/MANIFEST.MF"/>
+ manifest="${conf.home}/MANIFEST.MF"
+ excludes="**/*.html"
+ />
</target>
@@ -279,7 +287,7 @@
<!-- ================================================================== -->
<!-- E X A M P L E S -->
<!-- ================================================================== -->
- <target name="examples" depends="jar,install-jar,docs,javadocs"
+ <target name="examples" depends="install-jar,docs,javadocs"
description="Setup example application">
<!-- Setup example applications -->
@@ -289,15 +297,21 @@
<fileset dir="${examples.home}" includes="*.war"/>
</delete>
- <!-- Deploy jars -->
+ <!-- Assemble and build the simple example -->
<delete>
- <fileset dir="${examples.home}/simple/WEB-INF/lib" includes="velocity-tools-view*.jar"/>
+ <fileset dir="${examples.home}/simple/WEB-INF/lib" includes="*.jar"/>
</delete>
<copy todir="${examples.home}/simple/WEB-INF/lib" filtering="no">
<fileset dir="${project.repository}">
<include name="velocity-tools-view*.jar"/>
+ <include name="commons-beanutils*.jar"/>
+ <include name="commons-collections*.jar"/>
+ <include name="commons-digester*.jar"/>
+ <include name="dom4j*.jar"/>
+ <include name="velocity-dep-*.jar"/>
</fileset>
</copy>
+ <ant dir="examples/simple" target="all" inheritAll="false"/>
</target>
1.5 +14 -25 jakarta-velocity-tools/view/examples/simple/build.xml
Index: build.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/examples/simple/build.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- build.xml 22 May 2002 08:18:39 -0000 1.4
+++ build.xml 23 Jun 2002 09:45:16 -0000 1.5
@@ -1,7 +1,7 @@
-<project name="Velocity Tools" default="war" basedir=".">
+<project name="Velocity Tools" default="all" basedir=".">
-<!-- ========== Initialize Properties ===========================+======= -->
+<!-- ========== Initialize Properties ================================== -->
<property name="DEV" value="${basedir}/"/>
<property name="SRC" value="${basedir}/WEB-INF/src"/>
@@ -31,30 +31,16 @@
<!-- ================================================================== -->
- <!-- H E L P -->
+ <!-- A L L -->
<!-- ================================================================== -->
- <target name="help" depends="init">
- <!-- Print usage information -->
- <echo> </echo>
- <echo>Usage: ant <target> </echo>
- <echo> </echo>
- <echo>where the following targets are supported: </echo>
- <echo> </echo>
- <echo> compile Compile all sources. </echo>
- <echo> </echo>
- <echo> clean Clean dev tree and previously generated distributions. </echo>
- <echo> </echo>
- <echo> war Pack the entire application into a war file. </echo>
- <echo> </echo>
- <echo> help Print this help information. </echo>
- <echo> </echo>
- </target>
+ <target name="all" depends="war"
+ description="Build entire example"/>
<!-- ================================================================== -->
<!-- C O M P I L E -->
<!-- ================================================================== -->
- <target name="compile" depends="">
+ <target name="compile" depends="init">
<!-- Compile the java code from ${SRC} into ${CLASSES} -->
<javac srcdir="${SRC}"
includes="*/**"
@@ -68,18 +54,21 @@
<!-- ================================================================== -->
<!-- W A R -->
<!-- ================================================================== -->
- <target name="war" depends="init, clean, compile">
- <jar jarfile="${basedir}/../simple.war" basedir="${DEV}"/>
+ <target name="war" depends="compile">
+ <jar jarfile="${basedir}/../simple.war"
+ basedir="${DEV}"
+ excludes="**/MANIFEST.MF"/>
<echo> </echo>
+ <echo> </echo>
<echo> A WAR file (Web ARchive) was created for you in </echo>
<echo> the directory above. (/examples) It is called </echo>
<echo> </echo>
<echo> simple.war </echo>
<echo> </echo>
<echo> To use it with Tomcat, copy the .war file to </echo>
- <echo> the webapps directory in the tomcat tree </echo>
- <echo> (assuming a standard tomcat installation) and </echo>
+ <echo> the webapps directory in the Tomcat tree </echo>
+ <echo> (assuming a standard Tomcat installation) and </echo>
<echo> then restart Tomcat. To access the page </echo>
<echo> point you browser to </echo>
<echo> </echo>
@@ -92,7 +81,7 @@
<!-- ================================================================== -->
- <!-- C L E A B -->
+ <!-- C L E A N -->
<!-- ================================================================== -->
<target name="clean">
<!-- remove old class files -->
1.3 +4 -0 jakarta-velocity-tools/view/examples/simple/WEB-INF/web.xml
Index: web.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/view/examples/simple/WEB-INF/web.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- web.xml 9 Jan 2002 11:26:40 -0000 1.2
+++ web.xml 23 Jun 2002 09:45:16 -0000 1.3
@@ -27,4 +27,8 @@
<url-pattern>*.vm</url-pattern>
</servlet-mapping>
+ <welcome-file-list>
+ <welcome-file>index.vm</welcome-file>
+ </welcome-file-list>
+
</web-app>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>