You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by jv...@locus.apache.org on 2000/09/30 19:36:11 UTC
cvs commit: jakarta-velocity/xdocs contributors.xml design.xml index.xml install.xml
jvanzyl 00/09/30 10:36:11
Modified: xdocs contributors.xml design.xml index.xml install.xml
Log:
- routine edits.
Revision Changes Path
1.2 +1 -1 jakarta-velocity/xdocs/contributors.xml
Index: contributors.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/contributors.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- contributors.xml 2000/09/30 17:04:30 1.1
+++ contributors.xml 2000/09/30 17:36:10 1.2
@@ -29,7 +29,7 @@
<p>
We are following a certification scheme like the one that is outlined here:
<link href="http://www.advogato.org/certs.html">http://www.advogato.org/certs.html</link>.
- The ordering of the names is based on the first contributor at the top to the most recent
+ Names on this list are ordered from first contributor at the top to the most recent contributor
at the bottom.
</p>
1.2 +37 -39 jakarta-velocity/xdocs/design.xml
Index: design.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/design.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- design.xml 2000/09/30 17:04:30 1.1
+++ design.xml 2000/09/30 17:36:10 1.2
@@ -15,54 +15,52 @@
<s1 title="Design">
<p>
- Velocity is a Java based template engine. It can be used as a
- stand-alone utility for generating source code, HTML, reports,
+ Velocity is a Java-based template engine. It can be used as a
+ standalone utility for generating source code, HTML, reports,
or it can be combined with other systems to provide template
- services. One such example is the planned marriage of Velocity
- with the <link href="http://java.apache.org/turbine">Turbine</link>
- web application framework. Velocity will be tightly integrated with Turbine
- to provide a template service that will enable a true MVC model
- by which web applications may be developed.
+ services. Velocity will be tightly integrated with the
+ <link href="http://java.apache.org/turbine">Turbine</link>
+ web application framework to provide a template service that will
+ enable a true MVC model by which web applications may be developed.
</p>
<p>
- The original concept for Velocity was borrowed from WebMacro. We are
- gratious for the amount of development and design work that went into
- WebMacro.
+ Velocity allows web page designers to embed simple and useful script
+ elements in HTML code. These script elements work in conjunction with
+ a Context object that is populated in your Java code. A context object--
+ essentially a Hashtable that provides get and set methods for retrieving and setting
+ objects by name within the Context--provides a "hook" from your
+ Java code to your Velocity code. These script elements allow a web
+ designer to retrieve objects from the Context and
+ put them into a web page as text values. The web designer has some control over
+ looping (for each) and conditional statements (if/else).
</p>
-
+
<p>
- The fundamental design of Velocity is around the idea that there are a few
- useful script elements that you embed within your HTML code that work in
- conjunction with a Context object that is populated in your Java code. The
- purpose of the Context object is to provide a "hook" from your
- Java code to your Velocity code. Essentially a Context object is simply a
- Hashtable which provides get and set methods for retrieving and setting
- objects by name within the Context. These script elements provide enough
- basic functionality to allow you to retrieve objects from the Context and
- put them into your page as text values with some degree of control over
- looping (for each) and conditional statements (if/else).
+ Velocity enforces a Model-View-Controller (MVC) style of development
+ by separating Java code from HTML template code. Unlike Java Servlet Pages (JSPs),
+ Velocity does not allow Java code to be embedded in pages. Unlike PHP,
+ Velocity does not implement features with other functions. The MVC
+ approach is one of Velocity's great strengths, and allows for more
+ maintainable and better designed web pages.
</p>
-
+
<p>
- For people who are not familiar with MVC style of development, at first
- glance, it will appear as though Velocity is missing a large set of
- functionality. It turns out that this is actually the strength of Velocity.
- For example, unlike JSP, there is no way to embed Java code within your page
- and the script elements provide little more than basic looping and
- conditional statements. Another example is the PHP model where every single
- feature is implemented with another function. So, how is this better than
- the alternatives? The answer is that by using Velocity, you are enforcing a
- MVC style of development which defines that your Java code and your HTML
- template code should be separate. This style of development sometimes takes
- slightly longer (especially if you are new to MVC), but results in much more
- maintainable code over the long term (believe us, we have been doing this
- for a long time now). It also provides an abstraction that prevents page
- designers from messing with software engineer's Java code. In other words,
- it provides an enforcement of a contract that defines what roles people play
- in the development process.
+ Although MVC-style development can sometimes lead to longer incubation
+ periods for web sites, particularly if the developers involved are new
+ to MVC, this approach saves time over the long term (believe us, we have
+ been doing this for a long time now). The MVC abstraction prevents web page
+ designers from messing with a software engineer's Java code, and
+ programmers from unduly influencing the look of web sites. This enforces
+ a contract that defines what roles people play in the web site development process.
+ </p>
+
+ <p>
+ The concept for Velocity was borrowed from WebMacro, and those involved in
+ the Velocity project acknowledge and appreciates the development and design
+ work that went into the WebMacro project.
</p>
-
+
</s1>
</body>
1.2 +18 -18 jakarta-velocity/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- index.xml 2000/09/30 17:04:30 1.1
+++ index.xml 2000/09/30 17:36:10 1.2
@@ -15,29 +15,29 @@
<s1 title="What is Velocity?">
<p>
- Velocity is a Java based template engine. It can be used as a
- stand-alone utility for generating source code, HTML, reports,
+ Velocity is a Java-based template engine. It can be used as a
+ standalone utility for generating source code, HTML, reports,
or it can be combined with other systems to provide template
- services. One such example is the planned marriage of Velocity
- with the <link href="http://java.apache.org/turbine/">Turbine</link>
- web application framework. Velocity will be tightly integrated with Turbine
- to provide a template service that will enable a true MVC model
- by which web applications may be developed.
+ services. Velocity will be tightly integrated with the
+ <link href="http://java.apache.org/turbine/">Turbine</link>
+ web application framework to provide a template service that
+ will enable a true MVC model by which web applications may be
+ developed.
</p>
<p>
- Velocity uses a grammar based parser generated by
+ Velocity uses a grammar-based parser generated by
<link href="http://www.metamata.com/javacc/">JavaCC</link>
(Java Compiler Compiler) using the JJTree extension to create an
- Abstract Syntax Tree (AST) which may subsequently be traversed
- (repeatedly if desired) by a tree walker. The tree walker
+ Abstract Syntax Tree (AST). The AST may subsequently be traversed
+ (repeatedly if desired) by a tree walker, which
is implemented using the visitor design pattern. This allows
the parsing logic to be separated from the actions performed
- on the resultant AST. For example there are two visitors that
- come with Velocity: the first is a simple implementation that produces
- a visual tree of the syntax and nothing more, mostly used for
- debugging; the second is the visitor that actually generates
- output from user defined values and introspection.
+ on the resultant AST. Two visitors come with Velocity: the first
+ is a simple implementation that produces a visual tree of the
+ syntax and nothing more, mostly used for
+ debugging; the second visitor actually generates
+ output from user-defined values and introspection.
</p>
</s1>
@@ -48,7 +48,7 @@
<p>
There is no official release yet, but there will be one
- shortly. But you may retrieve the full source via <link
+ shortly. The full source can be retrieved via <link
href="http://jakarta.apache.org/getinvolved/cvsindex.html">CVS</link>.
</p>
@@ -57,7 +57,7 @@
<s1 title="Where do I get nightly builds?">
<p>
- You can find the builds
+ You can find nightly builds
<link href="http://jakarta.apache.org/builds/jakarta-velocity/nightly/">here</link>.
</p>
@@ -66,7 +66,7 @@
<s1 title="How do I contribute, give feedback, fix bugs and so on?">
<p>
- We really need and appreciate any contributions you can give. This includes
+ We really need and appreciate any contributions you can give, including
documentation help, source code and feedback. Discussion about changes
should come in the form of source code and/or very detailed and well thought
out constructive feedback.
1.2 +4 -4 jakarta-velocity/xdocs/install.xml
Index: install.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity/xdocs/install.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- install.xml 2000/09/30 17:04:30 1.1
+++ install.xml 2000/09/30 17:36:10 1.2
@@ -35,14 +35,14 @@
<p>
Executing the above script will create a "bin" directory within the Velocity
- distribution directory. In there will be the compiled class files (inside a
+ distribution directory. The bin directory will contain the compiled class files (inside a
"classes" directory) as well as a "velocity.jar" file. You can either use
the .jar file directly or copy the org directory into your classpath.
</p>
<p>
- If you get compiler error about not being able to find some package, then
- it means that you have not edited the scripts to properly specify the paths
+ If you get a compiler error about not being able to find some package, then
+ ensure the scripts are edited to properly specify the paths
to each of the packages.
</p>
@@ -51,7 +51,7 @@
<s1 title="Testing Your Installation">
<p>
- There is testing scripts in the velocity/examples directory.
+ There are testing scripts in the velocity/examples directory.
</p>
</s1>