| |
| |
| <html> |
| <head> |
| <title>Velocity - VelocityTools Project</title> |
| |
| <meta name="author" value="Geir Magnusson Jr."/> |
| <meta name="email" value="geirm@apache.org" /> |
| <meta name="author" value="Gabriel Sidler"/> |
| <meta name="email" value="sidler@apache.org" /> |
| |
| |
| </head> |
| |
| <body bgcolor="#ffffff" text="#000000" link="#525D76" |
| alink="#525D76" vlink="#525D76"> |
| |
| <table border="0" width="100%" cellspacing="4"> |
| |
| <tr><td colspan="2"> |
| |
| <a href="http://velocity.apache.org/"> |
| <img src="http://velocity.apache.org/images/velocity_project_wide.png" |
| align="left" alt="The Velocity Project" border="0"/> |
| </a> |
| |
| |
| |
| <a href="index.html"> |
| <img src="images/velocitytools.png" align="right" alt="< Velocity Tools >" border="0"/> |
| </a> |
| |
| </td></tr> |
| |
| <tr> |
| <td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td> |
| </tr> |
| |
| <tr> |
| |
| <td width="20%" valign="top" nowrap="true"> |
| |
| <p><strong><a href="http://velocity.apache.org">Velocity</a></strong></p> |
| |
| <p> |
| <strong>Velocity Tools</strong> |
| </p> |
| <ul> |
| <li><a href="index.html">Overview</a></li> |
| <li><a href="index.html#Download">Download</a></li> |
| <li><a href="changes.html">ChangeLog</a></li> |
| <li><a href="index.html#Subversion Repository">Subversion Repository</a></li> |
| <li><a href="javadoc/index.html">Javadoc</a></li> |
| <li><a href="http://wiki.apache.org/jakarta-velocity/VelocityTools">Wiki</a></li> |
| <li><a href="http://wiki.apache.org/jakarta-velocity/VelocityFAQ">FAQ</a></li> |
| <li><a href="http://issues.apache.org/jira/browse/VELTOOLS">Report Issues</a></li> |
| |
| </ul> |
| <p> |
| <strong>Subprojects</strong> |
| </p> |
| <ul> |
| <li><a href="generic/">GenericTools</a></li> |
| <li><a href="view/">VelocityView</a></li> |
| <li><a href="struts/">VelocityStruts</a></li> |
| |
| </ul> |
| |
| |
| </td> |
| |
| <!-- RIGHT SIDE MAIN BODY --> |
| <td colspan="1" valign="top" align="left"> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Overview"> |
| <strong>Overview</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p> |
| 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> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#828DA6"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="GenericTools"> |
| <strong>GenericTools</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <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"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#828DA6"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="VelocityView"> |
| <strong>VelocityView</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p><a href="view/">VelocityView</a> |
| contains a standalone servlet (VelocityViewServlet) which can render |
| templates for web applications. </p> |
| <p> Also included is a Toolbox Manager which can automatically make |
| "view tools" and data available to the templates. Any class |
| with public methods can be used as a tool in the template. |
| </p> |
| <p> |
| <a href="view/layoutservlet.html">VelocityLayoutServlet</a> is an |
| extension of the basic VelocityViewServlet that can render screen |
| content into common layout templates.</p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#828DA6"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="VelocityStruts"> |
| <strong>VelocityStruts</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <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 |
| <a href="http://struts.apache.org/">Apache Struts</a> framework.</p> |
| <p>This work leverages the <strong>VelocityViewServlet</strong> and |
| additional tools which make it easy to integrate the Velocity with |
| Struts. Several example hybrid applications are included.</p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#828DA6"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Example Applications"> |
| <strong>Example Applications</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p>Several example applications are currently available, including |
| one to demonstrate the use of Velocity as a view technology for Struts. |
| The example utilizes both Velocity and JSP files for the view in parallel |
| so that they can be compared easily. Also, resources bundle usage for |
| language localization is demonstrated there. Other examples include a demonstration |
| of the use of the VelocityLayoutServlet and a minimal "simple" application.</p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#828DA6"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Documentation"> |
| <strong>Documentation</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p> |
| Emphasis <s>is</s> was being put on providing tool documentation that |
| is suitable for template designers. To achive this goal, a documentation |
| format has been defined that captures all information relevant to the |
| template designer. It is being supplied in addition to the customary |
| Javadoc. This should help to achieve what we always claim for Velocity: |
| "Decouple the work of template designers from the work of software |
| developers". Look at the Struts |
| <a href="struts/MessageTool.html">MessageTool</a> |
| for a good example of the new documentation format. |
| </p> |
| <p> |
| <b>Update:</b> |
| While we value the look and readability of this format, we are presently |
| drifting away from the use of it. The primary reason for this is that the |
| developers have found it difficult to maintain (i.e. no one |
| has been motivated enough to put in the extra work). If you feel this |
| documentation format is valuable and wish to help us create and maintain |
| it for the various individual tools, please see |
| <a href="#Wanna help?">below</a> |
| for more details on getting involved. Meanwhile, we'll be putting effort |
| into improving javadoc for individual tools and overview documents for |
| the sub-projects. |
| </p> |
| |
| </td> |
| </tr> |
| </table> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Download"> |
| <strong>Download</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p><strong>Releases</strong></p> |
| <p> |
| The latest versions are available for |
| <a href="http://velocity.apache.org/download.cgi">download</a> |
| in source or binary form. |
| </p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Subversion Repository"> |
| <strong>Subversion Repository</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <p>All VelocityTools project code is maintained in the |
| Subversion repository <a href="http://svn.apache.org/repos/asf/velocity/tools/"> |
| http://svn.apache.org/repos/asf/velocity/tools/</a>.</p> |
| <p>Web Browser: <a href="http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/"> |
| http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/</a></p> |
| <p>Subversion Client: <a href="http://www.apache.org/dev/version-control.html">http://www.apache.org/dev/version-control.html</a>. |
| </p> |
| <br clear="all"/> |
| |
| </td> |
| </tr> |
| </table> |
| <table border="0" cellspacing="0" cellpadding="2" width="100%"> |
| <tr> |
| <td colspan="2" bgcolor="#525D76"> |
| <font color="#ffffff" face="arial,helvetica.sanserif"> |
| <a name="Wanna help?"> |
| <strong>Wanna help?</strong></a></font> |
| </td> |
| </tr> |
| <tr> |
| <td NOWRAP> </td> |
| <td> |
| <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 |
| mailing list or attached to a |
| <a href="http://issues.apache.org/jira/browse/VELTOOLS">JIRA</a> |
| issue. The <a href="http://wiki.apache.org/velocity/VelocityTools">Wiki</a> |
| can also be a good place to discuss and develop ideas.</p> |
| <p>A few good places to get started include: |
| <ul> |
| <li>Documentation (patches for the site or additions to the Wiki)</li> |
| <li>Improving the example apps</li> |
| <li>Contributing to the <a href="http://wiki.apache.org/elocity/VelocimacroLibrary">VelocimacroLibrary</a></li> |
| </ul> |
| Other project goals and proposals can be found in the project |
| <a href="http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/STATUS?view=markup">STATUS</a> |
| file.</p> |
| |
| </td> |
| </tr> |
| </table> |
| |
| </td> |
| |
| </tr> |
| |
| <!-- FOOTER SEPARATOR --> |
| <tr> |
| <td colspan="2"> |
| <hr noshade="" size="1"/> |
| </td> |
| </tr> |
| |
| <!-- PAGE FOOTER --> |
| <tr><td colspan="2"> |
| <div align="center"><font color="#525D76" size="-1"><em> |
| Copyright © 1999-2003, Apache Software Foundation |
| </em></font></div> |
| </td></tr> |
| |
| </table> |
| </body> |
| </html> |
