<?xml version="1.0" encoding="UTF-8" ?>
<!--
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    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
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.
-->
<document>
  <properties>
    <title>Dependencies</title>
    <projectfile>xdocs/project.xml</projectfile>
  </properties>
  <body>
    <section name="Dependencies">
      <p>
        VelocityTools requires certain external jar dependencies at
        different times. These charts should help you determine which
        jars you need and when.
      </p>
      <p class="note">
        Note: Java version 1.5+ is required for compilation, testing
        and use of VelocityTools 2.
      </p>

      <subsection name="GenericTools">
          <table>
            <tr>
              <th>Jar Name</th>
              <th>Version</th>
              <th>Compile</th>
              <th>Runtime</th>
              <th>Notes</th>
            </tr>
            <tr>
              <td>commons-beanutils</td>
              <td>1.7.0</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/MathTool.html">MathTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/generic/SortTool.html">SortTool</a>
              </td>
            </tr>
            <tr>
              <td>commons-collections</td>
              <td>3.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Velocity requires this.</td>
            </tr>
            <tr>
              <td>commons-digester</td>
              <td>1.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for
                <a href="config.xml.html">xml configuration</a>
              </td>
            </tr>
            <tr>
              <td>commons-lang</td>
              <td>2.1</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required for
                <a href="javadoc/org/apache/velocity/tools/generic/EscapeTool.html">EscapeTool</a>
              </td>
            </tr>
            <tr>
              <td>commons-logging</td>
              <td>1.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for Digester and
                <a href="javadoc/org/apache/velocity/tools/generic/log/LogChuteCommonsLog.html">LogChuteCommonsLog</a></td>
            </tr>
            <tr>
              <td>dom4j</td>
              <td>1.1+</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required only for
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a></td>
            </tr>
            <tr>
              <td>oro</td>
              <td>2.0+</td>
              <td>No</td>
              <td>No</td>
              <td>A Velocity dependency (only used by certain EventHandlers)</td>
            </tr>
            <tr>
              <td>velocity</td>
              <td>1.5</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/ClassTool.html">ClassTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/LinkTool.html">LinkTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/LoopTool.html">LoopTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/RenderTool.html">RenderTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a>
              </td>
            </tr>
          </table>
      </subsection>

      <subsection name="VelocityView">
          <table>
            <tr>
              <th>Jar Name</th>
              <th>Version</th>
              <th>Compile</th>
              <th>Runtime</th>
              <th>Notes</th>
            </tr>
            <tr>
              <td>commons-beanutils</td>
              <td>1.7.0</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/MathTool.html">MathTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/generic/SortTool.html">SortTool</a>
              </td>
            </tr>
            <tr>
              <td>commons-collections</td>
              <td>3.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Velocity requires this.</td>
            </tr>
            <tr>
              <td>commons-digester</td>
              <td>1.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for
                <a href="config.xml.html">xml configuration</a>
              </td>
            </tr>
            <tr>
              <td>commons-lang</td>
              <td>2.1</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required for
                <a href="javadoc/org/apache/velocity/tools/generic/EscapeTool.html">EscapeTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/view/VelocityViewServlet.html">VelocityViewServlet</a>
              </td>
            </tr>
            <tr>
              <td>commons-logging</td>
              <td>1.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for Digester and
                <a href="javadoc/org/apache/velocity/tools/generic/log/LogChuteCommonsLog.html">LogChuteCommonsLog</a></td>
            </tr>
            <tr>
              <td>dom4j</td>
              <td>1.1+</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required only for
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a></td>
            </tr>
            <tr>
              <td>oro</td>
              <td>2.0+</td>
              <td>No</td>
              <td>No</td>
              <td>A Velocity dependency (only used by certain EventHandlers)</td>
            </tr>
            <tr>
              <td>servletapi</td>
              <td>2.3</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for all
                <a href="javadoc/org/apache/velocity/tools/view/package-summary.html">VelocityView</a>
                tools except for
                <a href="javadoc/org/apache/velocity/tools/generic/RenderTool.html">RenderTool</a>
              </td>
            </tr>
            <tr>
              <td>velocity</td>
              <td>1.5</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/ClassTool.html">ClassTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/RenderTool.html">RenderTool</a>
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a>
                <a href="javadoc/org/apache/velocity/tools/view/AbstractSearchTool.html">AbstractSearchTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/ContextTool.html">ContextTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/ImportTool.html">ImportTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/LinkTool.html">LinkTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/LoopTool.html">LoopTool</a>,
                and
                <a href="javadoc/org/apache/velocity/tools/view/MultiViewsTool.html">MultiViewsTool</a>
              </td>
            </tr>
          </table>
      </subsection>

      <subsection name="VelocityStruts">
          <table>
            <tr>
              <th>Jar Name</th>
              <th>Version</th>
              <th>Compile</th>
              <th>Runtime</th>
              <th>Notes</th>
            </tr>
            <tr>
              <td>commons-beanutils</td>
              <td>1.7.0</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/MathTool.html">MathTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/generic/SortTool.html">SortTool</a>
              </td>
            </tr>
            <tr>
              <td>commons-chain</td>
              <td>1.1</td>
              <td>No</td>
              <td>Yes</td>
              <td>Struts 1.3+ requires this.</td>
            </tr>
            <tr>
              <td>commons-collections</td>
              <td>3.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Velocity requires this.</td>
            </tr>
            <tr>
              <td>commons-digester</td>
              <td>1.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for
                <a href="config.xml.html">xml configuration</a>
              </td>
            </tr>
            <tr>
              <td>commons-lang</td>
              <td>2.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for Struts,
                <a href="javadoc/org/apache/velocity/tools/generic/EscapeTool.html">EscapeTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/view/VelocityViewServlet.html">VelocityViewServlet</a>
              </td>
            </tr>
            <tr>
              <td>commons-logging</td>
              <td>1.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for Struts, Digester, and LogChuteCommonsLog</td>
            </tr>
            <tr>
              <td>dom4j</td>
              <td>1.1+</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required only for
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a></td>
            </tr>
            <tr>
              <td>struts-core</td>
              <td>1.3.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for all
                <a href="javadoc/org/apache/velocity/tools/struts/package-summary.html">VelocityStruts</a>
                tools
              </td>
            </tr>
            <tr>
              <td>struts-taglib</td>
              <td>1.3.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for
                <a href="javadoc/org/apache/velocity/tools/struts/FormTool.html">FormTool</a>,
                <a href="javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/struts/StrutsLinkTool.html">StrutsLinkTool</a>
              </td>
            </tr>
            <tr>
              <td>struts-tiles</td>
              <td>1.3.8</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for
                <a href="javadoc/org/apache/velocity/tools/struts/TilesTool.html">TilesTool</a>
              </td>
            </tr>
            <tr>
              <td>ssl-ext</td>
              <td>1.2</td>
              <td>Yes</td>
              <td>No</td>
              <td>Required for
                <a href="javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</a>
              </td>
            </tr>
            <tr>
              <td>commons-validator</td>
              <td>1.3.1</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for 
                <a href="javadoc/org/apache/velocity/tools/struts/ValidatorTool.java">ValidatorTool</a>
              </td>
            </tr>
            <tr>
              <td>oro</td>
              <td>2.0+</td>
              <td>No</td>
              <td>No</td>
              <td>A Velocity dependency (only used by certain EventHandlers)</td>
            </tr>
            <tr>
              <td>servletapi</td>
              <td>2.3</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for all
                <a href="javadoc/org/apache/velocity/tools/struts/package-summary.html">VelocityStruts</a>
                tools and all
                <a href="javadoc/org/apache/velocity/tools/view/package-summary.html">VelocityView</a>
                tools except for
                <a href="javadoc/org/apache/velocity/tools/generic/RenderTool.html">RenderTool</a>
              </td>
            </tr>
            <tr>
              <td>velocity</td>
              <td>1.5</td>
              <td>Yes</td>
              <td>Yes</td>
              <td>Required for core infrastructure,
                <a href="javadoc/org/apache/velocity/tools/generic/ClassTool.html">ClassTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/RenderTool.html">RenderTool</a>,
                <a href="javadoc/org/apache/velocity/tools/generic/XmlTool.html">XmlTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/AbstractSearchTool.html">AbstractSearchTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/ContextTool.html">ContextTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/ImportTool.html">ImportTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/LinkTool.html">LinkTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/LoopTool.html">LoopTool</a>,
                <a href="javadoc/org/apache/velocity/tools/view/MultiViewsTool.html">MultiViewsTool</a>,
                <a href="javadoc/org/apache/velocity/tools/struts/SecureLinkTool.html">SecureLinkTool</a>,
                <a href="javadoc/org/apache/velocity/tools/struts/StrutsLinkTool.html">StrutsLinkTool</a>,
                <a href="javadoc/org/apache/velocity/tools/struts/TilesTool.html">TilesTool</a>
                and
                <a href="javadoc/org/apache/velocity/tools/struts/MessageTool.html">MessageTool</a>
              </td>
            </tr>
          </table>
      </subsection>

    </section>
  </body>
</document>
