You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@velocity.apache.org by ap...@apache.org on 2011/01/11 13:20:56 UTC
svn commit: r1057602 - in /velocity/tools/trunk:
maven-velocity-tools-plugin/pom.xml src/site/xdoc/index.xml
Author: apetrelli
Date: Tue Jan 11 12:20:56 2011
New Revision: 1057602
URL: http://svn.apache.org/viewvc?rev=1057602&view=rev
Log:
VELTOOLS-132
Finished documentation.
Modified:
velocity/tools/trunk/maven-velocity-tools-plugin/pom.xml
velocity/tools/trunk/src/site/xdoc/index.xml
Modified: velocity/tools/trunk/maven-velocity-tools-plugin/pom.xml
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/maven-velocity-tools-plugin/pom.xml?rev=1057602&r1=1057601&r2=1057602&view=diff
==============================================================================
--- velocity/tools/trunk/maven-velocity-tools-plugin/pom.xml (original)
+++ velocity/tools/trunk/maven-velocity-tools-plugin/pom.xml Tue Jan 11 12:20:56 2011
@@ -8,8 +8,10 @@
</parent>
<groupId>org.apache.velocity</groupId>
<artifactId>maven-velocity-tools-plugin</artifactId>
+ <name>Apache Velocity Tools - Maven plugin</name>
<version>2.1.0-SNAPSHOT</version>
<packaging>maven-plugin</packaging>
+ <description>Maven plugin to work with Velocity Tools</description>
<profiles>
<profile>
<id>maven3</id>
Modified: velocity/tools/trunk/src/site/xdoc/index.xml
URL: http://svn.apache.org/viewvc/velocity/tools/trunk/src/site/xdoc/index.xml?rev=1057602&r1=1057601&r2=1057602&view=diff
==============================================================================
--- velocity/tools/trunk/src/site/xdoc/index.xml (original)
+++ velocity/tools/trunk/src/site/xdoc/index.xml Tue Jan 11 12:20:56 2011
@@ -8,9 +8,9 @@
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
-
+
http://www.apache.org/licenses/LICENSE-2.0
-
+
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -30,133 +30,149 @@
<section name="Overview">
<p>
- A Velocity "tool" is just a POJO (plain old java object) that is
- "useful" in a template and is not meant to be rendered in the
- output. In other words, a "tool" (in Velocity-speak) is meant
- to be used but not seen themselves (e.g. for formatting dates
+ A Velocity "tool" is just a POJO (plain old java object) that is
+ "useful" in a template and is not meant to be rendered in the
+ output. In other words, a "tool" (in Velocity-speak) is meant
+ to be used but not seen themselves (e.g. for formatting dates
or numbers, url building, etc).
</p>
<p>
- The VelocityTools project is, first of all, a collection of such
- useful Java classes, as well as infrastructure to easily,
- automatically and transparently make these tools available to your
- Velocity templates. Other aims of the project include providing
- easy integration of Velocity into the view-layer of your web
- applications (via the
- <a href="view.tag.html">VelocityViewTag</a> and
- <a href="view.servlet.html">VelocityViewServlet</a>)
+ The VelocityTools project is, first of all, a collection of such
+ useful Java classes, as well as infrastructure to easily,
+ automatically and transparently make these tools available to your
+ Velocity templates. Other aims of the project include providing
+ easy integration of Velocity into the view-layer of your web
+ applications (via the
+ <a href="view.tag.html">VelocityViewTag</a>,
+ <a href="view.servlet.html">VelocityViewServlet</a>), the
+ <a href="maven-velocity-tools-plugin/index.html">Maven plugin</a>
and integration with Struts 1.x applications.
</p>
<p>
- In recognition of these varying aims, the VelocityTools project is
- divided into three parts: <a href="generic.html">GenericTools</a>,
+ In recognition of these varying aims, the VelocityTools project is
+ divided into three parts: <a href="generic.html">GenericTools</a>,
<a href="view.html">VelocityView</a> and <a href="struts.html">
- VelocityStruts</a>. Each of these parts builds on the previous one
+ VelocityStruts</a>. Each of these parts builds on the previous one
and has its own JAR distribution.
</p>
<subsection name="GenericTools">
<p>
- <a href="generic.html">GenericTools</a> is the set of classes
- that provide basic infrastructure for using tools in standard
- Java SE Velocity projects, as well as a set of tools for use
- in generic Velocity templates. Perenial favorites here are
- the DateTool, NumberTool and RenderTool, though there are many
+ <a href="generic.html">GenericTools</a> is the set of classes
+ that provide basic infrastructure for using tools in standard
+ Java SE Velocity projects, as well as a set of tools for use
+ in generic Velocity templates. Perenial favorites here are
+ the DateTool, NumberTool and RenderTool, though there are many
others available as well.
</p>
</subsection>
<subsection name="VelocityView">
<p>
- <a href="view.html">VelocityView</a> includes all of the
- <a href="generic.html">GenericTools</a> structure and
- specialized tools for using Velocity in the view layer of web
- applications (Java EE projects). This includes the
- <a href="view.servlet.html">VelocityViewServlet</a> or
+ <a href="view.html">VelocityView</a> includes all of the
+ <a href="generic.html">GenericTools</a> structure and
+ specialized tools for using Velocity in the view layer of web
+ applications (Java EE projects). This includes the
+ <a href="view.servlet.html">VelocityViewServlet</a> or
<a href="view.layoutservlet.html">VelocityLayoutServlet</a>
- for processing Velocity template requests and the
- <a href="view.tag.html">VelocityViewTag</a> for
- embedding Velocity in JSP. Popular tools here are the LinkTool
+ for processing Velocity template requestsm the
+ <a href="view.tag.html">VelocityViewTag</a> for
+ embedding Velocity in JSP and a
+ <a href="maven-velocity-tools-plugin/index.html">Maven plugin</a>
+ to embed JSP tag libraries in Velocity templates.
+ Popular tools here are the LinkTool
and the ParameterTool.
</p>
</subsection>
<subsection name="VelocityStruts">
<p>
- <a href="struts.html">VelocityStruts</a> includes both
+ <a href="struts.html">VelocityStruts</a> includes both
<a href="view.html">VelocityView</a> and <a href="generic.html">
- GenericTools</a> and adds tools for use in Struts 1.x
- applications. These tools match the functions of the key
- Struts taglibs and provide access to Struts resources, messages,
+ GenericTools</a> and adds tools for use in Struts 1.x
+ applications. These tools match the functions of the key
+ Struts taglibs and provide access to Struts resources, messages,
tiles, validation functions and more.
</p>
</subsection>
<p>
- It is worth noting that these tools, being POJOs (though some
- require a little configuration) are generally useful and may be
- used within your java classes or even other template languages,
- though you may need to instantiate and configure them manually (not
- difficult) to do so. VelocityTools 2 has been designed with this
- in mind. Ask on the user mailing list if you have questions about
+ It is worth noting that these tools, being POJOs (though some
+ require a little configuration) are generally useful and may be
+ used within your java classes or even other template languages,
+ though you may need to instantiate and configure them manually (not
+ difficult) to do so. VelocityTools 2 has been designed with this
+ in mind. Ask on the user mailing list if you have questions about
using VelocityTools without Velocity.
</p>
</section>
+ <section name="What's new in 2.1">
+ <p>
+ Velocity Tools 2.1 has the following new features:
+ </p>
+ <ul>
+ <li>
+ A <a href="maven-velocity-tools-plugin/index.html">Maven plugin</a> to allow embedding
+ of JSP tag libraries inside Velocity templates.
+ </li>
+ </ul>
+ </section>
+
<section name="Why 2.0?">
<p>
- Those already familiar with VelocityTools 1.x may be curious about
- the goals and motivations behind developing VelocityTools 2.
- In planning and developing the 2.0 release, there were three main
+ Those already familiar with VelocityTools 1.x may be curious about
+ the goals and motivations behind developing VelocityTools 2.
+ In planning and developing the 2.0 release, there were three main
goals:
</p>
<ul>
<li>
- Transparent, on-demand tool instantiation (aka lazy loading
- for tools) - This allows you to have many tools available
- (even ones that are expensive to instantiate), but not waste
- time instantiating or initializing/configuring those you don't
+ Transparent, on-demand tool instantiation (aka lazy loading
+ for tools) - This allows you to have many tools available
+ (even ones that are expensive to instantiate), but not waste
+ time instantiating or initializing/configuring those you don't
use for every request.
</li>
<li>
- More accessible, reusable infrastructure - This allows easier
- access to tools outside of your templates and provides better
- means to integrate VelocityTools support into other web
- frameworks or even other view technologies
+ More accessible, reusable infrastructure - This allows easier
+ access to tools outside of your templates and provides better
+ means to integrate VelocityTools support into other web
+ frameworks or even other view technologies
(e.g. VelocityViewTag).
</li>
<li>
- Simpler, more flexible toolbox
- <a href="config.html">configuration</a> - Now you can
- configure via a
- <a href="config.properties.html">properties file</a>,
- <a href="config.java.html">plain java</a>, or really
- whatever you want (though perhaps with a bit more work). No
+ Simpler, more flexible toolbox
+ <a href="config.html">configuration</a> - Now you can
+ configure via a
+ <a href="config.properties.html">properties file</a>,
+ <a href="config.java.html">plain java</a>, or really
+ whatever you want (though perhaps with a bit more work). No
<a href="config-xml.html">XML</a> required anymore; though,
if you do use it, it's now a lot better than it was.
</li>
</ul>
<p>
- These things could not have been accomplished without rewriting
- most of the core infrastructure and configuration code. At the
- same time, we wanted to make it easy for people to upgrade from
- the 1.x series. This led to the decision to aim for complete
- backwards compatibility. Granted much has been deprecated and
- those who directly used or extended the 1.x infrastructure will
- have to update their code in just a few releases, but for the time
- being they should be able to use 2.0 in their applications with
- few problems. Those who merely used the old toolbox.xml format or
- the old tools directly will be immediately able to take advantage
- of the new infrastructure without even updating their
- configuration, though eventually even the old toolbox.xml format
- may be retired. Don't cry. You'll like the
- <a href="config-xml.html">new one</a> better once
+ These things could not have been accomplished without rewriting
+ most of the core infrastructure and configuration code. At the
+ same time, we wanted to make it easy for people to upgrade from
+ the 1.x series. This led to the decision to aim for complete
+ backwards compatibility. Granted much has been deprecated and
+ those who directly used or extended the 1.x infrastructure will
+ have to update their code in just a few releases, but for the time
+ being they should be able to use 2.0 in their applications with
+ few problems. Those who merely used the old toolbox.xml format or
+ the old tools directly will be immediately able to take advantage
+ of the new infrastructure without even updating their
+ configuration, though eventually even the old toolbox.xml format
+ may be retired. Don't cry. You'll like the
+ <a href="config-xml.html">new one</a> better once
you get to know it! It can do much more with much less typing.
</p>
@@ -164,16 +180,16 @@
<section name="Subversion Repository">
<p>
- All VelocityTools project code is maintained in the Subversion
- repository which can be reached in a number of ways. The most
- direct method of accessing the repository is through a
- web browser, but to effectively work on the code, a
+ All VelocityTools project code is maintained in the Subversion
+ repository which can be reached in a number of ways. The most
+ direct method of accessing the repository is through a
+ web browser, but to effectively work on the code, a
<a href="http://svn.tigris.org/links.html#clients">Subversion
client</a> is required.
</p>
<p>
- Repository:
+ Repository:
<a href="http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/">
http://svn.apache.org/viewcvs.cgi/velocity/tools/trunk/
</a>
@@ -186,8 +202,8 @@
<p>
Feedback about the project, whether positive or gently critical,
is always helpful to those working on the project. Such feedback
- may be sent to either the user@velocity.apache.org or
- dev@velocity.apache.org
+ may be sent to either the user@velocity.apache.org or
+ dev@velocity.apache.org
<a href="http://velocity.apache.org/contact.html">mailing lists</a>.
</p>
<p>
@@ -202,7 +218,7 @@
</subsection>
<subsection name="Contribution">
<p>
- Those interested in furthering the development of this
+ Those interested in furthering the development of this
project have an open invitation to jump in and help out.
We welcome your contributions!
Patches can be sent to the mailing list or attached to a
@@ -212,16 +228,16 @@
</p>
<p>A few good places to get started include:</p>
<ul>
- <li>Documentation (patches for the site or additions to
+ <li>Documentation (patches for the site or additions to
the Wiki)</li>
<li>Improving the example apps</li>
<li>Working on unresolved tasks in
<a href="http://issues.apache.org/jira/browse/VELTOOLS">JIRA</a></li>
- <li>Contributing to the
+ <li>Contributing to the
<a href="http://wiki.apache.org/velocity/VelocimacroLibrary">VelocimacroLibrary</a></li>
</ul>
<p>
- Other project goals and proposals can be found in the project
+ 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>
</subsection>
@@ -249,5 +265,5 @@
</section>
</body>
-
+
</document>