You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by jo...@apache.org on 2001/03/19 03:52:25 UTC
cvs commit: jakarta-velocity/xdocs getting-started.xml install.xml migration.xml texen.xml
jon 01/03/18 18:52:25
Modified: docs developer-guide.html getting-started.html
install.html migration.html texen.html
xdocs getting-started.xml install.xml migration.xml
texen.xml
Log:
fixed line wrapping
fixed new names of build scripts
fixed name of directory for api docs
minor cleanup
Revision Changes Path
1.33 +2 -2 jakarta-velocity/docs/developer-guide.html
Index: developer-guide.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/developer-guide.html,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- developer-guide.html 2001/03/17 05:19:28 1.32
+++ developer-guide.html 2001/03/19 02:52:24 1.33
@@ -1123,8 +1123,8 @@
</p>
<strong> #include() and #parse() Directive </strong>
<p>
-<code>directive.include.output.errormsg.start = <!-- include error : </code><br />
-<code>directive.include.output.errormsg.end = see error log --> </code><br />
+<code>directive.include.output.errormsg.start = <![CDATA[ <!-- include error : ]]> </code><br />
+<code>directive.include.output.errormsg.end = <![CDATA[ see error log --> ]]></code><br />
Defines the beginning and ending tags for an in-stream error message in the case of a problem with the #include() directive.
If both the .start and .end tags are defined, an error message will be output to the stream, of the form '.start msg .end' where .start and .end refer to the property values.
Output to the render stream will only occur if both the .start and .end (next) tag are defined.
1.22 +3 -5 jakarta-velocity/docs/getting-started.html
Index: getting-started.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/getting-started.html,v
retrieving revision 1.21
retrieving revision 1.22
diff -u -r1.21 -r1.22
--- getting-started.html 2001/03/15 07:10:47 1.21
+++ getting-started.html 2001/03/19 02:52:24 1.22
@@ -127,7 +127,7 @@
<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
- <filename>build</filename> directory and run the following script.
+ <code>build</code> directory and run the following script.
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -139,9 +139,7 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
- ./build-velocity.sh javadocs
-
+./build.sh javadocs
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -153,7 +151,7 @@
</table>
</div>
<p>
- If you are working on Windows, running <code>build-velocity.bat javadocs
+ If you are working on Windows, running <code>build.bat javadocs
</code> at the DOS prompt will have the same effect.
</p>
</blockquote>
1.23 +54 -47 jakarta-velocity/docs/install.html
Index: install.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/install.html,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -r1.22 -r1.23
--- install.html 2001/03/15 07:10:47 1.22
+++ install.html 2001/03/19 02:52:24 1.23
@@ -105,14 +105,15 @@
<tr><td>
<blockquote>
<p>
-Velocity runs on a variety of platforms that have installed the Java 2 Virtual
-Machine. The J2SDK is required for users who want to compile Velocity from its
-source code.
+Velocity runs on a variety of platforms that have installed the Java 2
+Virtual Machine. The J2SDK is required for users who want to compile
+Velocity from its source code.
</p>
<p>
-Everything required to build Velocity comes with the distribution, which can be
-obtained from <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">CVS</a>
-or from the <a href="http://jakarta.apache.org/builds/jakarta-velocity/nightly/">nightly builds</a>.
+Everything required to build Velocity comes with the distribution, which
+can be obtained from <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">CVS</a> or
+from the <a href="http://jakarta.apache.org/builds/jakarta-velocity/nightly/">nightly
+builds</a>.
</p>
<p>
The directory tree of the distribution looks like :
@@ -127,18 +128,16 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
jakarta-velocity
/build - contains build scripts
/bin - where the built jars / classes will go
/src - sourcecode for Velocity, Anakia, and Texen
/docs - documentation in HTML form
- /docs/apidocs - Javadocs for Velocity source
+ /docs/api - Javadocs for Velocity source
/examples - example/demonstration code
/convert - tools to help convert WebMacro templates
/test - test programs and templates
/xdocs - source for our documentation
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -161,21 +160,24 @@
<tr><td>
<blockquote>
<p>
-To make building Velocity easy and consistant, we have provided scripts to build
-Velocity for both Unix and Windows. We use a Jakarta project called
-<a href="http://jakarta.apache.org/ant/">Ant</a> to perform
-the build process and provide Ant with the distribution, so no
-external build utilities are required.
-</p>
- <p>
-In each case below, it is assumed that you were successful in getting the distribution from CVS
-or as a nightly build, and with the latter, were successful in unpacking. Also, it is assumed that
-you are starting in the 'jakarta-velocity' directory, the root of the distribution tree. All directory
-references will be relative to 'jakarta-velocity'.
+To make building Velocity easy and consistant, we have provided scripts
+to build Velocity for both Unix and Windows. We use a Jakarta project
+called <a href="http://jakarta.apache.org/ant/">Ant</a> to perform the
+build process and provide Ant with the distribution, so no external
+build utilities are required.
+</p>
+ <p>
+In each case below, it is assumed that you were successful in getting
+the distribution from CVS or as a nightly build, and with the latter,
+were successful in unpacking. Also, it is assumed that you are starting
+in the 'jakarta-velocity' directory, the root of the distribution tree.
+All directory references will be relative to 'jakarta-velocity'.
+</p>
+ <p>
+On Unix, change to the <filename>build</filename> directory (<code>cd
+build</code>). Then, build the Velocity jar via the build.sh
+script :
</p>
- <p>
-On Unix, change to the <filename>build</filename> directory (<code>cd build</code>). Then, build the Velocity jar via the build-velocity.sh script :
-</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
@@ -186,7 +188,7 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-./build-velocity.sh
+./build.sh
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -198,7 +200,9 @@
</table>
</div>
<p>
-On Windows, change to the <filename>build</filename> directory (<code>cd build</code>). Then, build the Velocity jar via the build-velocity.bat script :
+On Windows, change to the <filename>build</filename> directory
+(<code>cd build</code>). Then, build the Velocity jar via the
+build.bat script :
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -210,7 +214,7 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-build-velocity.bat
+build.bat
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -222,24 +226,25 @@
</table>
</div>
<p>
-Executing this script will create a <filename>bin</filename> directory within
-the Velocity distribution directory. The <filename>bin</filename> directory will
-contain the compiled class files (inside a <filename>classes</filename>
-directory) as well as a <filename>velocity-XX.jar</filename> file,
-where XX is the current version number. Be sure to
-update your classpath to include Velocity's <filename>.jar</filename> file.
+Executing this script will create a <filename>bin</filename> directory
+within the Velocity distribution directory. The <filename>bin</filename>
+directory will contain the compiled class files (inside a
+<filename>classes</filename> directory) as well as a
+<filename>velocity-XX.jar</filename> file, where XX is the current
+version number. Be sure to update your classpath to include Velocity's
+<filename>.jar</filename> file.
</p>
<p>
Velocity should build 'out of the box', independent of your classpath.
-If you get an error building Velocity, try a different nightly build (as sometimes
-we make a mistake and the CVS at the time of the nightly snapshot isn't complete)
-or refresh from CVS (you might have gotten a CVS snapshot while a developer was
-checking things in.)
+If you get an error building Velocity, try a different nightly build (as
+sometimes we make a mistake and the CVS at the time of the nightly
+snapshot isn't complete) or refresh from CVS (you might have gotten a
+CVS snapshot while a developer was checking things in.)
</p>
<p>
-If the problems persist, do not hesitate to ask the Velocity community via our mail
-lists. They can be found <a href="http://jakarta.apache.org/site/mail.html">here</a>.
-Please read and understand the the guidelines for participating in any Jakarta mail
+If the problems persist, do not hesitate to ask the Velocity community
+via our mail lists. They can be found <a href="http://jakarta.apache.org/site/mail.html">here</a>. Please read
+and understand the the guidelines for participating in any Jakarta mail
list.
</p>
</blockquote>
@@ -254,11 +259,13 @@
<tr><td>
<blockquote>
<p>
-The Velocity developers use an automated test facility, and it is included in the
-distribution. You can use it to make sure that all is well with your build of Velocity.
+The Velocity developers use an automated test facility, and it is
+included in the distribution. You can use it to make sure that all is
+well with your build of Velocity.
</p>
<p>
-To run the test suite, simply use the build target <filename>test</filename> when you build :
+To run the test suite, simply use the build target
+<filename>test</filename> when you build :
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -270,9 +277,9 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-Unix : ./build-velocity.sh test
+Unix : ./build.sh test
-Windows : build-velocity.bat test
+Windows : build.bat test
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -314,7 +321,6 @@
Time: 2.553
OK (38 tests)
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -326,8 +332,9 @@
</table>
</div>
<p>
-Note that the number of tests may vary from those shown above, but if you see 'OK'
-after the tests are run, all is well. Now it's time to use Velocity.
+Note that the number of tests may vary from those shown above, but if
+you see 'OK' after the tests are run, all is well. Now it's time to use
+Velocity.
</p>
</blockquote>
</td></tr>
1.15 +20 -18 jakarta-velocity/docs/migration.html
Index: migration.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/migration.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -r1.14 -r1.15
--- migration.html 2001/03/15 07:10:47 1.14
+++ migration.html 2001/03/19 02:52:24 1.15
@@ -105,13 +105,14 @@
<tr><td>
<blockquote>
<p>
- Legacy documents are the bane of any software migration. The Velocity
- Team has tried to ensure that existing templates can be converted
- for use within Velocity in as painless a manner as possible.
+ Legacy documents are the bane of any software migration. The
+ Velocity Team has tried to ensure that existing templates can be
+ converted for use within Velocity in as painless a manner as
+ possible.
</p>
<p>
- Currently there is only a WebMacro to Velocity template converter, but
- there are plans for a Tea to Velocity template converter, and a
+ Currently there is only a WebMacro to Velocity template converter,
+ but there are plans for a Tea to Velocity template converter, and a
FreeMarker to Velocity template converter.
</p>
</blockquote>
@@ -126,14 +127,14 @@
<tr><td>
<blockquote>
<p>
- The <filename>convert-wm.sh</filename> script in the <filename>convert</filename> directory
- converts a single WebMacro template (<filename>*.wm</filename>) to a Velocity
- template (<filename>*.vm</filename>), or converts an entire directory structure
- of WebMacro templates to Velocity templates.
+ The <code>convert-wm.sh</code> script in the <code>convert</code>
+ directory converts a single WebMacro template (<code>*.wm</code>) to
+ a Velocity template (<code>*.vm</code>), or converts an entire
+ directory structure of WebMacro templates to Velocity templates.
</p>
<p>
- The <filename>convert-wm.sh</filename> script can convert a single
- WebMacro template to a Velocity template.
+ The <code>convert-wm.sh</code> script can convert a single WebMacro
+ template to a Velocity template.
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
@@ -158,12 +159,13 @@
</div>
<p>
This will produce a single Velocity template named
- <filename>template.vm</filename> from the WebMacro template <filename>template.wm</filename>.
- The original WebMacro template will be preserved.
+ <code>template.vm</code> from the WebMacro template
+ <code>template.wm</code>. The original WebMacro template will be
+ preserved.
</p>
<p>
To convert an entire directory structure of WebMacro templates using
- the <filename>convert-wm.sh</filename> script, simply include the directory
+ the <code>convert-wm.sh</code> script, simply include the directory
name instead of the template name, as indicated below.
</p>
<div align="left">
@@ -176,8 +178,8 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
- ./convert-wm.sh template.wm
- </pre></td>
+./convert-wm.sh template.wm
+</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
@@ -188,8 +190,8 @@
</table>
</div>
<p>
- This will produce a directory structure of templates
- named <filename>templates.vm</filename>. The original WebMacro templates will be
+ This will produce a directory structure of templates named
+ <code>templates.vm</code>. The original WebMacro templates will be
preserved during the conversion process.
</p>
</blockquote>
1.13 +19 -27 jakarta-velocity/docs/texen.html
Index: texen.html
===================================================================
RCS file: /home/cvs/jakarta-velocity/docs/texen.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- texen.html 2001/03/15 07:10:48 1.12
+++ texen.html 2001/03/19 02:52:24 1.13
@@ -107,21 +107,20 @@
<p>
Texen is a general purpose text generating utility. It is capable of
producing almost any sort of text output. Driven by Ant, essentially
- an <a href="http://jakarta.apache.org/ant/">Ant</a>
- Task, Texen uses a control template, an optional set of worker templates,
- and control context to govern the generated output. Although TexenTask
- can be used directly, it is usually subclassed to initialize your control
+ an <a href="http://jakarta.apache.org/ant/">Ant</a> Task, Texen uses
+ a control template, an optional set of worker templates, and control
+ context to govern the generated output. Although TexenTask can be
+ used directly, it is usually subclassed to initialize your control
context before generating any output.
</p>
<p>
- Texen was created to deal with the source generating
- requirements of the Turbine web application framework. The
- <a href="http://java.apache.org/turbine/torque.html">Torque</a>
- utility in <a href="http://java.apache.org/turbine/">Turbine</a>,
- which is a subclass of the TexenTask, is responsible
- for generating the SQL, and the Object-Relational mapping sources
- for a Turbine project. This is only one example; you can use
- Texen to generate almost any sort of text output!
+ Texen was created to deal with the source generating requirements of
+ the Turbine web application framework. The <a href="http://java.apache.org/turbine/torque.html">Torque</a> utility
+ in <a href="http://java.apache.org/turbine/">Turbine</a>, which is a
+ subclass of the TexenTask, is responsible for generating the SQL,
+ and the Object-Relational mapping sources for a Turbine project.
+ This is only one example; you can use Texen to generate almost any
+ sort of text output!
</p>
</blockquote>
</td></tr>
@@ -135,8 +134,8 @@
<tr><td>
<blockquote>
<p>
- This trivial example, which shows how to use Texen from an Ant build.xml,
- is intended to illustrate how the Texen mechanism works.
+ This trivial example, which shows how to use Texen from an Ant
+ build.xml, is intended to illustrate how the Texen mechanism works.
</p>
<p>
<em>Ant Build File</em>
@@ -151,7 +150,6 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
<project name="HtmlGenerator" default="main" basedir=".">
<taskdef name="texen" classname="org.apache.velocity.texen.ant.TexenTask"/>
@@ -181,7 +179,6 @@
</target>
</project>
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -222,7 +219,6 @@
$generator.parse("HtmlTemplate.vm", $outputFile, "planet", $planet)
#end
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -246,7 +242,6 @@
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
-
#*
file: HtmlTemplate.vm
@@ -271,7 +266,6 @@
</body>
</html>
-
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
@@ -283,16 +277,14 @@
</table>
</div>
<p>
- Texen produces three html pages: Earth.html,
- Mars.html, and Venus.html. To do something
- more useful, you would subclass the TexenTask, place some objects
- in the control context, and use the information placed in the
- control context to generate useful output.
+ Texen produces three html pages: Earth.html, Mars.html, and
+ Venus.html. To do something more useful, you would subclass the
+ TexenTask, place some objects in the control context, and use the
+ information placed in the control context to generate useful output.
</p>
<p>
- See the Torque utility in Turbine for a full working example of Texen.
- A standalone version of Torque is available
- <a href="http://java.apache.org/turbine/tdk/">here</a>.
+ See the Torque utility in Turbine for a full working example of
+ Texen. A standalone version of Torque is available <a href="http://java.apache.org/turbine/tdk/">here</a>.
</p>
</blockquote>
</td></tr>
1.8 +3 -5 jakarta-velocity/xdocs/getting-started.xml
Index: getting-started.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/getting-started.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- getting-started.xml 2001/02/26 06:38:54 1.7
+++ getting-started.xml 2001/03/19 02:52:24 1.8
@@ -29,17 +29,15 @@
<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
- <filename>build</filename> directory and run the following script.
+ <code>build</code> directory and run the following script.
</p>
<source><![CDATA[
-
- ./build-velocity.sh javadocs
-
+./build.sh javadocs
]]></source>
<p>
- If you are working on Windows, running <code>build-velocity.bat javadocs
+ If you are working on Windows, running <code>build.bat javadocs
</code> at the DOS prompt will have the same effect.
</p>
1.13 +55 -43 jakarta-velocity/xdocs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/install.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- install.xml 2001/03/01 06:00:52 1.12
+++ install.xml 2001/03/19 02:52:24 1.13
@@ -12,15 +12,18 @@
<section name="Installation">
<p>
-Velocity runs on a variety of platforms that have installed the Java 2 Virtual
-Machine. The J2SDK is required for users who want to compile Velocity from its
-source code.
+Velocity runs on a variety of platforms that have installed the Java 2
+Virtual Machine. The J2SDK is required for users who want to compile
+Velocity from its source code.
</p>
<p>
-Everything required to build Velocity comes with the distribution, which can be
-obtained from <a href="http://jakarta.apache.org/getinvolved/cvsindex.html">CVS</a>
-or from the <a href="http://jakarta.apache.org/builds/jakarta-velocity/nightly/">nightly builds</a>.
+Everything required to build Velocity comes with the distribution, which
+can be obtained from <a
+href="http://jakarta.apache.org/getinvolved/cvsindex.html">CVS</a> or
+from the <a
+href="http://jakarta.apache.org/builds/jakarta-velocity/nightly/">nightly
+builds</a>.
</p>
<p>
@@ -28,18 +31,16 @@
</p>
<source><![CDATA[
-
jakarta-velocity
/build - contains build scripts
/bin - where the built jars / classes will go
/src - sourcecode for Velocity, Anakia, and Texen
/docs - documentation in HTML form
- /docs/apidocs - Javadocs for Velocity source
+ /docs/api - Javadocs for Velocity source
/examples - example/demonstration code
/convert - tools to help convert WebMacro templates
/test - test programs and templates
/xdocs - source for our documentation
-
]]></source>
</section>
@@ -47,56 +48,64 @@
<section name="Building">
<p>
-To make building Velocity easy and consistant, we have provided scripts to build
-Velocity for both Unix and Windows. We use a Jakarta project called
-<a href='http://jakarta.apache.org/ant/'>Ant</a> to perform
-the build process and provide Ant with the distribution, so no
-external build utilities are required.
+To make building Velocity easy and consistant, we have provided scripts
+to build Velocity for both Unix and Windows. We use a Jakarta project
+called <a href='http://jakarta.apache.org/ant/'>Ant</a> to perform the
+build process and provide Ant with the distribution, so no external
+build utilities are required.
</p>
<p>
-In each case below, it is assumed that you were successful in getting the distribution from CVS
-or as a nightly build, and with the latter, were successful in unpacking. Also, it is assumed that
-you are starting in the 'jakarta-velocity' directory, the root of the distribution tree. All directory
-references will be relative to 'jakarta-velocity'.
+In each case below, it is assumed that you were successful in getting
+the distribution from CVS or as a nightly build, and with the latter,
+were successful in unpacking. Also, it is assumed that you are starting
+in the 'jakarta-velocity' directory, the root of the distribution tree.
+All directory references will be relative to 'jakarta-velocity'.
</p>
<p>
-On Unix, change to the <filename>build</filename> directory (<code>cd build</code>). Then, build the Velocity jar via the build-velocity.sh script :
+On Unix, change to the <filename>build</filename> directory (<code>cd
+build</code>). Then, build the Velocity jar via the build.sh
+script :
</p>
<source><![CDATA[
-./build-velocity.sh
+./build.sh
]]></source>
<p>
-On Windows, change to the <filename>build</filename> directory (<code>cd build</code>). Then, build the Velocity jar via the build-velocity.bat script :
+On Windows, change to the <filename>build</filename> directory
+(<code>cd build</code>). Then, build the Velocity jar via the
+build.bat script :
</p>
<source><![CDATA[
-build-velocity.bat
+build.bat
]]></source>
<p>
-Executing this script will create a <filename>bin</filename> directory within
-the Velocity distribution directory. The <filename>bin</filename> directory will
-contain the compiled class files (inside a <filename>classes</filename>
-directory) as well as a <filename>velocity-XX.jar</filename> file,
-where XX is the current version number. Be sure to
-update your classpath to include Velocity's <filename>.jar</filename> file.
+Executing this script will create a <filename>bin</filename> directory
+within the Velocity distribution directory. The <filename>bin</filename>
+directory will contain the compiled class files (inside a
+<filename>classes</filename> directory) as well as a
+<filename>velocity-XX.jar</filename> file, where XX is the current
+version number. Be sure to update your classpath to include Velocity's
+<filename>.jar</filename> file.
</p>
<p>
Velocity should build 'out of the box', independent of your classpath.
-If you get an error building Velocity, try a different nightly build (as sometimes
-we make a mistake and the CVS at the time of the nightly snapshot isn't complete)
-or refresh from CVS (you might have gotten a CVS snapshot while a developer was
-checking things in.)
+If you get an error building Velocity, try a different nightly build (as
+sometimes we make a mistake and the CVS at the time of the nightly
+snapshot isn't complete) or refresh from CVS (you might have gotten a
+CVS snapshot while a developer was checking things in.)
</p>
+
<p>
-If the problems persist, do not hesitate to ask the Velocity community via our mail
-lists. They can be found <a href='http://jakarta.apache.org/site/mail.html'>here</a>.
-Please read and understand the the guidelines for participating in any Jakarta mail
+If the problems persist, do not hesitate to ask the Velocity community
+via our mail lists. They can be found <a
+href='http://jakarta.apache.org/site/mail.html'>here</a>. Please read
+and understand the the guidelines for participating in any Jakarta mail
list.
</p>
@@ -105,22 +114,25 @@
<section name="Testing Your Installation">
<p>
-The Velocity developers use an automated test facility, and it is included in the
-distribution. You can use it to make sure that all is well with your build of Velocity.
+The Velocity developers use an automated test facility, and it is
+included in the distribution. You can use it to make sure that all is
+well with your build of Velocity.
</p>
<p>
-To run the test suite, simply use the build target <filename>test</filename> when you build :
+To run the test suite, simply use the build target
+<filename>test</filename> when you build :
</p>
<source><![CDATA[
-Unix : ./build-velocity.sh test
+Unix : ./build.sh test
-Windows : build-velocity.bat test
+Windows : build.bat test
]]></source>
<p>
If all is well, you should see output like :
</p>
+
<source><![CDATA[
test:
Running JUnit template tests for Velocity ...
@@ -140,12 +152,12 @@
Time: 2.553
OK (38 tests)
-
]]></source>
<p>
-Note that the number of tests may vary from those shown above, but if you see 'OK'
-after the tests are run, all is well. Now it's time to use Velocity.
+Note that the number of tests may vary from those shown above, but if
+you see 'OK' after the tests are run, all is well. Now it's time to use
+Velocity.
</p>
</section>
1.6 +21 -19 jakarta-velocity/xdocs/migration.xml
Index: migration.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/migration.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- migration.xml 2001/02/26 06:38:54 1.5
+++ migration.xml 2001/03/19 02:52:25 1.6
@@ -12,14 +12,15 @@
<section name="Converting Templates">
<p>
- Legacy documents are the bane of any software migration. The Velocity
- Team has tried to ensure that existing templates can be converted
- for use within Velocity in as painless a manner as possible.
+ Legacy documents are the bane of any software migration. The
+ Velocity Team has tried to ensure that existing templates can be
+ converted for use within Velocity in as painless a manner as
+ possible.
</p>
<p>
- Currently there is only a WebMacro to Velocity template converter, but
- there are plans for a Tea to Velocity template converter, and a
+ Currently there is only a WebMacro to Velocity template converter,
+ but there are plans for a Tea to Velocity template converter, and a
FreeMarker to Velocity template converter.
</p>
@@ -28,15 +29,15 @@
<section name="WebMacro to Velocity Template Converter">
<p>
- The <filename>convert-wm.sh</filename> script in the <filename>convert</filename> directory
- converts a single WebMacro template (<filename>*.wm</filename>) to a Velocity
- template (<filename>*.vm</filename>), or converts an entire directory structure
- of WebMacro templates to Velocity templates.
+ The <code>convert-wm.sh</code> script in the <code>convert</code>
+ directory converts a single WebMacro template (<code>*.wm</code>) to
+ a Velocity template (<code>*.vm</code>), or converts an entire
+ directory structure of WebMacro templates to Velocity templates.
</p>
<p>
- The <filename>convert-wm.sh</filename> script can convert a single
- WebMacro template to a Velocity template.
+ The <code>convert-wm.sh</code> script can convert a single WebMacro
+ template to a Velocity template.
</p>
<source><![CDATA[
@@ -45,23 +46,24 @@
<p>
This will produce a single Velocity template named
- <filename>template.vm</filename> from the WebMacro template <filename>template.wm</filename>.
- The original WebMacro template will be preserved.
+ <code>template.vm</code> from the WebMacro template
+ <code>template.wm</code>. The original WebMacro template will be
+ preserved.
</p>
<p>
To convert an entire directory structure of WebMacro templates using
- the <filename>convert-wm.sh</filename> script, simply include the directory
+ the <code>convert-wm.sh</code> script, simply include the directory
name instead of the template name, as indicated below.
</p>
- <source><![CDATA[
- ./convert-wm.sh template.wm
- ]]></source>
+<source><![CDATA[
+./convert-wm.sh template.wm
+]]></source>
<p>
- This will produce a directory structure of templates
- named <filename>templates.vm</filename>. The original WebMacro templates will be
+ This will produce a directory structure of templates named
+ <code>templates.vm</code>. The original WebMacro templates will be
preserved during the conversion process.
</p>
</section>
1.5 +22 -27 jakarta-velocity/xdocs/texen.xml
Index: texen.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/texen.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- texen.xml 2001/02/26 06:38:54 1.4
+++ texen.xml 2001/03/19 02:52:25 1.5
@@ -14,22 +14,22 @@
<p>
Texen is a general purpose text generating utility. It is capable of
producing almost any sort of text output. Driven by Ant, essentially
- an <a href="http://jakarta.apache.org/ant/">Ant</a>
- Task, Texen uses a control template, an optional set of worker templates,
- and control context to govern the generated output. Although TexenTask
- can be used directly, it is usually subclassed to initialize your control
+ an <a href="http://jakarta.apache.org/ant/">Ant</a> Task, Texen uses
+ a control template, an optional set of worker templates, and control
+ context to govern the generated output. Although TexenTask can be
+ used directly, it is usually subclassed to initialize your control
context before generating any output.
</p>
<p>
- Texen was created to deal with the source generating
- requirements of the Turbine web application framework. The
- <a href="http://java.apache.org/turbine/torque.html">Torque</a>
- utility in <a href="http://java.apache.org/turbine/">Turbine</a>,
- which is a subclass of the TexenTask, is responsible
- for generating the SQL, and the Object-Relational mapping sources
- for a Turbine project. This is only one example; you can use
- Texen to generate almost any sort of text output!
+ Texen was created to deal with the source generating requirements of
+ the Turbine web application framework. The <a
+ href="http://java.apache.org/turbine/torque.html">Torque</a> utility
+ in <a href="http://java.apache.org/turbine/">Turbine</a>, which is a
+ subclass of the TexenTask, is responsible for generating the SQL,
+ and the Object-Relational mapping sources for a Turbine project.
+ This is only one example; you can use Texen to generate almost any
+ sort of text output!
</p>
</section>
@@ -37,8 +37,8 @@
<section name="The TexenTask">
<p>
- This trivial example, which shows how to use Texen from an Ant build.xml,
- is intended to illustrate how the Texen mechanism works.
+ This trivial example, which shows how to use Texen from an Ant
+ build.xml, is intended to illustrate how the Texen mechanism works.
</p>
<p>
@@ -46,7 +46,6 @@
</p>
<source><![CDATA[
-
<project name="HtmlGenerator" default="main" basedir=".">
<taskdef name="texen" classname="org.apache.velocity.texen.ant.TexenTask"/>
@@ -76,7 +75,6 @@
</target>
</project>
-
]]></source>
<p>
@@ -101,14 +99,13 @@
$generator.parse("HtmlTemplate.vm", $outputFile, "planet", $planet)
#end
-
]]></source>
<p>
<em>Worker Template</em>
</p>
-<source><![CDATA[
+<source><![CDATA[
#*
file: HtmlTemplate.vm
@@ -133,21 +130,19 @@
</body>
</html>
-
]]></source>
<p>
- Texen produces three html pages: Earth.html,
- Mars.html, and Venus.html. To do something
- more useful, you would subclass the TexenTask, place some objects
- in the control context, and use the information placed in the
- control context to generate useful output.
+ Texen produces three html pages: Earth.html, Mars.html, and
+ Venus.html. To do something more useful, you would subclass the
+ TexenTask, place some objects in the control context, and use the
+ information placed in the control context to generate useful output.
</p>
<p>
- See the Torque utility in Turbine for a full working example of Texen.
- A standalone version of Torque is available
- <a href="http://java.apache.org/turbine/tdk/">here</a>.
+ See the Torque utility in Turbine for a full working example of
+ Texen. A standalone version of Torque is available <a
+ href="http://java.apache.org/turbine/tdk/">here</a>.
</p>
</section>