blob: 8757ce232699d77e29e2ecf7329a88bbebd2dfad [file] [log] [blame]
<!--
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.
-->
<j:jelly xmlns:j="jelly:core" xmlns:u="jelly:util" xmlns:ant="jelly:ant" xmlns:maven="jelly:maven">
<j:set var="destfile" value="${maven.build.dir}/generated-xdocs/dependencies.xml"/>
<ant:mkdir dir="${maven.build.dir}/generated-xdocs"/>
<u:file var="destfileFile" name="${destfile}"/>
<j:set var="destfile" value="${destfileFile.getCanonicalPath()}"/>
<j:set var="outputencoding" value="${maven.docs.outputencoding}"/>
<j:file name="${destfile}" encoding="${outputencoding}" outputMode="xml">
<document>
<properties>
<title>Dependencies</title>
</properties>
<body>
<section name="Dependencies">
<p>These are the various dependencies required by Wicket.</p>
<p>
If you're using maven to build your project and just want to know what
dependencies to add to your POM, just scroll down to the
<a href="#pomDependencies">next section</a>.
</p>
<subsection name="Required JARS">
<p>
The following list of JAR dependencies are required in order to be able
to use Wicket. These dependencies are also needed in the build process.
</p>
<table>
<tr>
<th>Required JARs</th>
<th>Description</th>
</tr>
<tr>
<td>wicket-extensions-${pom.currentVersion}.jar</td>
<td>The Wicket extensions classes</td>
</tr>
<j:forEach var="lib" items="${pom.artifacts}">
<j:set var="dep" value="${lib.dependency}"/>
<j:if test="${dep.getProperty('wicket.group')=='required'}">
<tr>
<td><a href="${dep.url}">${dep.artifact}</a></td>
<td>${dep.getProperty('wicket.description')}</td>
</tr>
</j:if>
</j:forEach>
</table>
</subsection>
<subsection name="Optional JARs">
<p>
The following JAR dependencies are optional. This means that depending on
your situation you might need (one of) these jars to use Wicket to the
fullest.
</p>
<table>
<tr>
<th>Optional JARs</th>
<th>Description</th>
</tr>
<j:forEach var="lib" items="${pom.artifacts}">
<j:set var="dep" value="${lib.dependency}"/>
<j:if test="${dep.getProperty('wicket.group')=='optional'}">
<tr>
<td><a href="${dep.url}">${dep.artifact}</a></td>
<td>${dep.getProperty('wicket.description')}</td>
</tr>
</j:if>
</j:forEach>
</table>
</subsection>
<subsection name="Build JARs">
<p>
The following depenencies are only used when you are building Wicket yourself.
These libraries are not necessary to create Wicket applications.
</p>
<table>
<tr>
<th>JARs for buiding Wicket</th>
<th>Description</th>
</tr>
<j:forEach var="lib" items="${pom.artifacts}">
<j:set var="dep" value="${lib.dependency}"/>
<j:if test="${dep.getProperty('wicket.group')=='test' or dep.getProperty('wicket.group')=='compile'}">
<tr>
<td><a href="${dep.url}">${dep.artifact}</a></td>
<td>${dep.getProperty('wicket.description')}</td>
</tr>
</j:if>
</j:forEach>
</table>
</subsection>
</section>
<section name="Dependencies">
<a name="pomDependencies"></a>
<p>
If you are using <a href="http://maven.apache.org">maven</a> to build
your project then you can simply cut and paste the following dependencies
into your project.xml.
</p>
<p>
Note that if you are reading this on the Wicket website then the version
numbers reflect what is currently in CVS, not necessarily what versions
are in use in the distribution that you have downloaded. In particular,
the version number for Wicket itself may not reflect a version currently
available in the maven repository.
</p>
<p>
If you are reading this from the documentation that came bundled with a
particular distribution of Wicket then you can use these values without
modification.
</p>
<source><![CDATA[<dependency>
<groupId>wicket</groupId>
<artifactId>wicket-extensions</artifactId>
<version>${pom.currentVersion}</version>
<properties>
<war.bundle>true</war.bundle>
</properties>
</dependency>]]>
<j:forEach var="lib" items="${pom.artifacts}"><j:set var="dep" value="${lib.dependency}" /><j:if
test="${dep.getProperty('wicket.group')=='optional' or dep.getProperty('wicket.group')=='required'}">
<br/><![CDATA[<dependency>
<groupId>${dep.groupId}</groupId>
<artifactId>${dep.artifactId}</artifactId>
<version>${dep.version}</version>
<properties>
<war.bundle>${dep.getProperty('war.bundle')}</war.bundle>
</properties>
</dependency>]]>
</j:if>
</j:forEach>
</source>
</section>
</body>
</document>
</j:file>
</j:jelly>