You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@velocity.apache.org by nb...@apache.org on 2003/11/06 07:56:02 UTC
cvs commit: jakarta-velocity-tools/xdocs/view index.xml layoutservlet.xml menu.xml
nbubna 2003/11/05 22:56:02
Modified: xdocs index.xml menu.xml
xdocs/generic menu.xml
xdocs/struts index.xml menu.xml
xdocs/view index.xml layoutservlet.xml menu.xml
Log:
start sprucing up some of the docs
Revision Changes Path
1.11 +15 -17 jakarta-velocity-tools/xdocs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/index.xml,v
retrieving revision 1.10
retrieving revision 1.11
diff -u -r1.10 -r1.11
--- index.xml 16 Oct 2003 19:53:02 -0000 1.10
+++ index.xml 6 Nov 2003 06:56:02 -0000 1.11
@@ -3,7 +3,7 @@
<document>
<properties>
- <title>Tools Sub-Project</title>
+ <title>VelocityTools Project</title>
<author email="geirm@apache.org">Geir Magnusson Jr.</author>
<author email="sidler@apache.org">Gabriel Sidler</author>
<projectfile>xdocs/menu.xml</projectfile>
@@ -12,11 +12,20 @@
<body>
<section name="Overview">
<p>
- Velocity Tools is a collection of Velocity sub-projects with a common goal
+ VelocityTools is a collection of Velocity subprojects with a common goal
of creating tools and infrastructure for building both web and non-web
applications using the Velocity template engine.
</p>
+ <subsection name="GenericTools" >
+ <p><a href="generic/">GenericTools</a> is a group of reuseable and
+ documented tools that can be added to a Velocity context. A
+ <b>tool</b> is simply a class which can perform various tasks when
+ made available to the Velocity engine. Most tools are optimized for use
+ with an automatically managed toolbox (see VelocityViewServlet).</p>
+ <br clear="all" />
+ </subsection>
+
<subsection name="VelocityView" >
<p><a href="view/">VelocityView</a>
contains a standalone servlet (VelocityViewServlet) which can render
@@ -32,15 +41,6 @@
<br clear="all" />
</subsection>
- <subsection name="Generic Tools" >
- <p><a href="generic/">Generic Tools</a> is a group of reuseable and
- documented tools that can be added to a Velocity context. A
- <b>tool</b> is simply a class which can perform various tasks when
- made available to the Velocity engine. Most tools are optimized for use
- with an automatically managed toolbox (see VelocityViewServlet).</p>
- <br clear="all" />
- </subsection>
-
<subsection name="VelocityStruts" >
<p><a href="struts/">VelocityStruts</a> is a set of tools for using the
Velocity template engine as the view layer for a web application built upon the
@@ -65,7 +65,7 @@
<section name="Download">
<p><strong>Releases</strong></p>
<p>
- Velocity Tools 1.0 has been released and is available
+ VelocityTools 1.0 has been released and is available
<a href="http://jakarta.apache.org/builds/jakarta-velocity-tools/">here</a>.
</p>
@@ -78,7 +78,7 @@
</section>
<section name="CVS Repository">
- <p>All Velocity Tools project code is maintained in the
+ <p>All VelocityTools project code is maintained in the
CVS repository <b>jakarta-velocity-tools</b>.</p>
<p>Web Browser: <a href="http://cvs.apache.org/viewcvs/jakarta-velocity-tools/">
@@ -90,9 +90,7 @@
</section>
<section name="Wanna help?">
- <p>This project is still young and has a growing user base. With the publicity
- of this first release, we expect the growth to increase significantly.
- We would like to encourage interested developers to evaluate the project
+ <p>We encourage interested developers to evaluate the project
and send feedback to the velocity-user or velocity-dev mailing list.</p>
<p>Those interested in furthering the development of this project are
especially welcome to jump in and help out. Patches can be sent to the
@@ -113,4 +111,4 @@
</section>
</body>
-</document>
\ No newline at end of file
+</document>
1.5 +2 -2 jakarta-velocity-tools/xdocs/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/menu.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- menu.xml 7 Aug 2003 05:20:35 -0000 1.4
+++ menu.xml 6 Nov 2003 06:56:02 -0000 1.5
@@ -17,9 +17,9 @@
<item name="Report Issues" href="http://issues.apache.org/bugzilla/enter_bug.cgi?product=Velocity&component=Tools"/>
</menu>
- <menu name="Sub-projects">
+ <menu name="Subprojects">
+ <item name="GenericTools" href="generic/"/>
<item name="VelocityView" href="view/"/>
- <item name="Generic Tools" href="generic/"/>
<item name="VelocityStruts" href="struts/"/>
</menu>
</body>
1.3 +10 -7 jakarta-velocity-tools/xdocs/generic/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/generic/menu.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menu.xml 9 Jul 2003 23:48:00 -0000 1.2
+++ menu.xml 6 Nov 2003 06:56:02 -0000 1.3
@@ -17,14 +17,17 @@
</menu>
<menu name="Tool Documentation">
- <item name="DateTool" href="DateTool.html"/>
- <item name="MathTool" href="MathTool.html"/>
- <item name="RenderTool" href="../javadoc/org/apache/velocity/tools/generic/RenderTool.html"/>
- <item name="IteratorTool" href="../javadoc/org/apache/velocity/tools/generic/IteratorTool.html"/> />
+ <item name="DateTool" href="../javadoc/org/apache/velocity/tools/generic/DateTool.html"/>
+ <item name="IteratorTool" href="../javadoc/org/apache/velocity/tools/generic/IteratorTool.html"/> />
+ <item name="MathTool" href="MathTool.html"/>
+ <item name="RenderTool" href="../javadoc/org/apache/velocity/tools/generic/RenderTool.html"/>
</menu>
- <printerversion/>
-
+ <menu name="Other Subprojects">
+ <item name="VelocityView" href="../view/"/>
+ <item name="VelocityStruts" href="../struts/"/>
+ </menu>
+ <printerversion/>
</body>
-</project>
\ No newline at end of file
+</project>
1.8 +22 -9 jakarta-velocity-tools/xdocs/struts/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/struts/index.xml,v
retrieving revision 1.7
retrieving revision 1.8
diff -u -r1.7 -r1.8
--- index.xml 16 Oct 2003 19:53:33 -0000 1.7
+++ index.xml 6 Nov 2003 06:56:02 -0000 1.8
@@ -6,6 +6,7 @@
<title>Overview</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<author email="tcolson@cisco.com">Tim Colson</author>
+ <author email="nbubna@apache.org">Nathan Bubna</author>
<projectfile>xdocs/struts/menu.xml</projectfile>
</properties>
@@ -61,8 +62,13 @@
people report being productive within a day.</li>
<li>Velocity is easy to extend with <i>Tools</i> which are simply
- any class which has public methods. These are typically easier to
- develop than JSP custom tag libraries.</li>
+ any class which has public methods. These are typically much cleaner
+ and easier to develop than JSP custom tag libraries.</li>
+
+ <li>Using the new TilesTool it is now possible
+ to mix Velocity and JSP tiles in the same page/layout. For those
+ using Tiles, this makes gradual migration between or integration of
+ the two view technologies trivially easy!</li>
<li>Velocity 'macros' are a powerful tool for the View Designer.
They enable the creation of reusable snippets of markup, often
@@ -104,26 +110,33 @@
development time.</i>"</p>
<p>"<i>Struts is a solid framework and Velocity makes it
even better.</i>"</p>
+ <p>"<i>I find that the Velocity Tools for Struts works as well, or better, with
+ Struts than another other presentation technology, bar none. In fact,
+ most of the tools work just as well with any other framework you might
+ care to name.</i>"
+ --<a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=velocity-user@jakarta.apache.org&msgNo=11255">Ted Husted</a>
+ (author of <a href="http://husted.com/struts/book.html">Struts in Action</a>)</p>
</blockquote>
</p>
</section>
<section name="What About Struts 1.1?">
- <p>Well, since our 1.0 release, we've been <a href="../changes.html">busy</a>. Thanks in large part to the
- efforts of our newest committer on the project (Marino), we've now
- implemented support for all of the new features in Struts 1.1. The latest
- nightly builds include support for ActionMessages, Tiles, javascript validation,
+ <p>Well, since our 1.0 release, we've been <a href="../changes.html">busy</a>!
+ Thanks mostly to the efforts of our newest committer on the project (Marino),
+ we've now implemented support for all of the new features in Struts 1.1.
+ VelocityStruts now supports ActionMessages, Tiles, javascript validation,
and modules, among numerous other improvements.</p>
- <p>In the meantime, here's a few tips for using Velocity Tools with Struts 1.1:
+ <p>For those not yet ready to step out and use a nightly build,
+ here's a few tips for using VelocityTools 1.0 with Struts 1.1:
<ol>
<li>Tiles alternatives:
- <a href="http://jakarta.apache.org/velocity/tools/view/layoutservlet.html">VelocityLayoutServlet</a>
+ <a href="../view/layoutservlet.html">VelocityLayoutServlet</a>
or the disscusion <a href="http://www.mail-archive.com/struts-user@jakarta.apache.org/msg63487.html">here</a></li>
<li>Wanna use Validator? There's some example code
<a href="http://www.mail-archive.com/velocity-user@jakarta.apache.org/msg09167.html">here</a></li>
- (though this doesn't demonstrate new client-side validation feature).
+ (note that this doesn't use the newly added support for javascript validation).
</ol>
</p>
1.4 +13 -7 jakarta-velocity-tools/xdocs/struts/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/struts/menu.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- menu.xml 17 Jul 2003 01:26:17 -0000 1.3
+++ menu.xml 6 Nov 2003 06:56:02 -0000 1.4
@@ -21,15 +21,21 @@
</menu>
<menu name="VelocityStruts Tools" href="StrutsTools.html">
- <item name="MessageTool" href="MessageTool.html"/>
- <item name="FormTool" href="FormTool.html"/>
- <item name="ErrorsTool" href="ErrorsTool.html"/>
- <item name="StrutsLinkTool" href="StrutsLinkTool.html"/>
+ <item name="ActionMessagesTool" href="../javadoc/org/apache/velocity/tools/struts/ActionMessagesTool.html"/>
+ <item name="ErrorsTool" href="ErrorsTool.html"/>
+ <item name="FormTool" href="FormTool.html"/>
+ <item name="MessageTool" href="MessageTool.html"/>
+ <item name="SecureLinkTool" href="../javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html"/>
+ <item name="StrutsLinkTool" href="StrutsLinkTool.html"/>
+ <item name="TilesTool" href="../javadoc/org/apache/velocity/tools/struts/TilesTool.html"/>
+ <item name="ValidatorTool" href="../javadoc/org/apache/velocity/tools/struts/ValidatorTool.html"/>
</menu>
- <printerversion/>
-
+ <menu name="Other Subprojects">
+ <item name="GenericTools" href="../generic/"/>
+ <item name="VelocityView" href="../view/"/>
+ </menu>
+ <printerversion/>
</body>
</project>
-
1.5 +22 -16 jakarta-velocity-tools/xdocs/view/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/view/index.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- index.xml 5 Aug 2003 00:33:42 -0000 1.4
+++ index.xml 6 Nov 2003 06:56:02 -0000 1.5
@@ -1,9 +1,7 @@
<?xml version="1.0"?>
-
<document>
-
<properties>
- <title>Tools - View Servlet</title>
+ <title>VelocityView</title>
<author email="sidler@apache.org">Gabriel Sidler</author>
<author email="geirm@apache.org">Geir Magnusson Jr.</author>
<author email="nbubna@apache.org">Nathan Bubna</author>
@@ -22,31 +20,33 @@
</p>
<p>Key features:</p>
<ul>
- <li><b>VelocityViewServlet class</b> - standalone servlet that renders Velocity
+ <li><b><a href="../javadoc/org/apache/velocity/tools/view/servlet/VelocityViewServlet.html">VelocityViewServlet</a>
+ class</b> - standalone servlet that renders Velocity
templates. Invoked directly from web clients requests, or via servlet
forwarding similar to how JSP files are rendered by JSPServlet.</li>
- <li>Attributes from ServletRequest, HttpSession, and ServletContext
- (request, session, application scopes - respectively) are automatically
- made available to the template.</li>
- <li>Tools can also be made available to the template, through a
+ <li>The HttpServletRequest, HttpSession, ServletContext,
+ and their attributes are automatically available in your templates.</li>
+ <li>Tools can also be made available to your templates, through a
<strong>toolbox</strong> configuration file.</li>
+ <li>A number of useful, extendable tools for developing web applications are
+ already provided for your convenience.</li>
<li>Logging can be directed to the log infrastructure of the Web application.
(default is the logging facility provided by the Servlet API).</li>
</ul>
- <p>Using VelocityViewServlet, it becomes possible to write Web applications that
+ <p>Using VelocityViewServlet, it becomes possible to write web applications that
are independent of a particular view technology. This opens a straightforward
migration path between JSP pages and Velocity templates as the view layer
technology in web applications.</p>
<p>A typical application use-case is to provide the view rendering layer for
- a Servlet-based web application framework. The
+ a servlet-based web application framework. The
<a href="../struts/">VelocityStruts</a> subproject
uses the approach to bring Velocity templates to the Struts application framework.</p>
</section>
<section name="Installation">
- <p>The VelocityViewServlet needs to be installed into our servlet container
+ <p>The VelocityViewServlet needs to be installed into your servlet container
so it can handle all request for *.vm (velocity template) files. There are
only two additional configuration files necessary, and they are shown in
detail below.</p>
@@ -161,14 +161,14 @@
<i>session</i>, or <i>application</i> scopes of your web app.</p>
<p>The scope that you set for your tool will determine both its
lifecycle and, if it implements the
- <code>org.apache.velocity.tools.view.tools.ViewTool</code> interface,
- then the scope will also determine what data is passed to the
+ <a href="../javadoc/org/apache/velocity/tools/view/tools/ViewTool.html">ViewTool</a>
+ interface, then the scope will also determine what data is passed to the
<code>init(Object)</code> method:</p>
<ul>
<li><i>application</i> scoped tools will be instantiated only once and then
reused for each request. Due to this, it is <em>strongly</em> encouraged
that your application scoped tools be completely threadsafe. The MathTool
- in the Generic Tools section is a good example of tool meant to be application
+ in the <a href="../generic/">GenericTools</a> section is a good example of tool meant to be application
scoped. If an application scoped tool implements ViewTool, then the
javax.servlet.ServletContext for the webapp will be passed to its
<code>init(Object)</code> method after it is instantiated.</li>
@@ -176,8 +176,9 @@
<li><i>session</i> scoped tools are instantiated once per unique session and
are then reused for every request associated with that particular session. If
a session scoped tool implements ViewTool, then its <code>init(Object)</code>
- method will be passed the ViewContext of the request during which the session
- was created.</li>
+ method will be passed the
+ <a href="../javadoc/org/apache/velocity/tools/view/context/ViewContext.html">ViewContext</a>
+ of the request during which the session was created.</li>
<li><i>request</i> is the default scope. If no scope is specified for a
<tool> in your toolbox.xml, then it will be automatically set as
@@ -242,6 +243,11 @@
(ex. $screen_content). Next, the servlet loads a 'layout' file. It
uses the existing data, including any additional variables set or
changed by the first template, to render a the layout template.</p>
+
+ <p>The VelocityLayoutServlet also allows you to specify an 'error'
+ template to be displayed when an exception is thrown during the
+ processing of a requested template. This allows you to provide
+ a customized error screen for a more user-friendly application.</p>
<p>Detailed documentation here: <a href="layoutservlet.html">VelocityLayoutServlet</a>.</p>
<br clear="all" />
1.5 +3 -1 jakarta-velocity-tools/xdocs/view/layoutservlet.xml
Index: layoutservlet.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/view/layoutservlet.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -r1.4 -r1.5
--- layoutservlet.xml 8 Sep 2003 19:16:27 -0000 1.4
+++ layoutservlet.xml 6 Nov 2003 06:56:02 -0000 1.5
@@ -25,7 +25,9 @@
to use it simply change the servlet-class value of the web.xml entry
to the following class:</p>
- <p><strong>org.apache.velocity.tools.view.servlet.VelocityLayoutServlet</strong></p>
+ <p>
+ <a href="../javadoc/org/apache/velocity/tools/view/servlet/VelocityLayoutServlet.html">org.apache.velocity.tools.view.servlet.VelocityLayoutServlet</a>
+ </p>
<subsection name="Configuration Settings" >
<p>Three settings can be added to velocity.properties to control
1.3 +10 -4 jakarta-velocity-tools/xdocs/view/menu.xml
Index: menu.xml
===================================================================
RCS file: /home/cvs/jakarta-velocity-tools/xdocs/view/menu.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- menu.xml 9 Jul 2003 23:48:00 -0000 1.2
+++ menu.xml 6 Nov 2003 06:56:02 -0000 1.3
@@ -18,10 +18,16 @@
</menu>
<menu name="VelocityView Tools">
- <item name="LinkTool" href="LinkTool.html"/>
- <item name="ParameterParser" href="ParameterParser.html"/>
- <item name="ViewRenderTool" href="../javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html"/>
- <item name="AbstractSearchTool" href="../javadoc/org/apache/velocity/tools/view/tools/AbstractSearchTool.html"/>
+ <item name="AbstractSearchTool" href="../javadoc/org/apache/velocity/tools/view/tools/AbstractSearchTool.html"/>
+ <item name="CookieTool" href="../javadoc/org/apache/velocity/tools/view/tools/CookieTool.html"/>
+ <item name="LinkTool" href="LinkTool.html"/>
+ <item name="ParameterParser" href="ParameterParser.html"/>
+ <item name="ViewRenderTool" href="../javadoc/org/apache/velocity/tools/view/tools/ViewRenderTool.html"/>
+ </menu>
+
+ <menu name="Other Subprojects">
+ <item name="GenericTools" href="../generic/"/>
+ <item name="VelocityStruts" href="../struts/"/>
</menu>
<printerversion/>
---------------------------------------------------------------------
To unsubscribe, e-mail: velocity-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: velocity-dev-help@jakarta.apache.org