Menu
▾
▴
[HtmlUnit] CVS Commit: htmlunit: Updated the dependency list page to get all
|
From: <no...@us...> - 2003-07-03 19:29:55
|
Log Message:
-----------
Updated the dependency list page to get all information from the pom so that all dependencies are kept in sync
Modified Files:
--------------
/cvsroot/htmlunit/htmlunit:
maven.xml
project.xml
/cvsroot/htmlunit/htmlunit/src/xdocs:
index.xml
Revision Data
-------------
Index: maven.xml
===================================================================
RCS file: /cvsroot/htmlunit/htmlunit/maven.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- maven.xml 16 Apr 2003 18:23:32 -0000 1.3
+++ maven.xml 3 Jul 2003 19:29:51 -0000 1.4
@@ -14,5 +14,95 @@
<preGoal name="xdoc:transform">
<attainGoal name="faq"/>
+ <attainGoal name="createDependenciesPage"/>
</preGoal>
+
+ <goal name="createDependenciesPage"
+ description="Generates the dependencies document">
+
+ <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 HtmlUnit. Some jars
+ are mandatory for even the simplest use of HtmlUnit, others are optional.
+ If the optional JARs are missing then the main functionality will
+ continue to work but some functions will not.
+ </p>
+ <table>
+ <tr><th>Required JARs</th><th>Description</th></tr>
+ <tr><td>HtmlUnit.jar</td><td>The main HtmlUnit classes</td></tr>
+ <j:forEach var="lib" items="${pom.artifacts}">
+ <j:set var="dep" value="${lib.dependency}"/>
+ <j:if test="${dep.getProperty('htmlunit.group')=='required'}">
+ <tr>
+ <tr>
+ <td><a href="${dep.url}">${dep.artifact}</a></td>
+ <td>${dep.getProperty('htmlunit.description')}</td>
+ </tr>
+ </tr>
+ </j:if>
+ </j:forEach>
+
+ <tr><th>Optional JARs for jelly scripting support</th><th>Description</th></tr>
+ <j:forEach var="lib" items="${pom.artifacts}">
+ <j:set var="dep" value="${lib.dependency}"/>
+ <j:if test="${dep.getProperty('htmlunit.group')=='jelly'}">
+ <tr>
+ <tr>
+ <td><a href="${dep.url}">${dep.artifact}</a></td>
+ <td>${dep.getProperty('htmlunit.description')}</td>
+ </tr>
+ </tr>
+ </j:if>
+ </j:forEach>
+
+ <tr><th>Optional JARs for running the unit tests</th><th>Description</th></tr>
+ <j:forEach var="lib" items="${pom.artifacts}">
+ <j:set var="dep" value="${lib.dependency}"/>
+ <j:if test="${dep.getProperty('htmlunit.group')=='test'}">
+ <tr>
+ <td><a href="${dep.url}">${dep.artifact}</a></td>
+ <td>${dep.getProperty('htmlunit.description')}</td>
+ </tr>
+ </j:if>
+ </j:forEach>
+
+ <tr><th>Optional JARs for SSL support</th><th>Description</th></tr>
+ <tr>
+ <td><a href="http://java.sun.com/products/jsse/">JSSE</a></td>
+ <td>Java Secure Socket Extension. Not required if you are running Java 1.4+</td>
+ </tr>
+
+ <tr><th>Other 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('htmlunit.group')=='optional'}">
+ <tr>
+ <tr>
+ <td><a href="${dep.url}">${dep.artifact}</a></td>
+ <td>${dep.getProperty('htmlunit.description')}</td>
+ </tr>
+ </tr>
+ </j:if>
+ </j:forEach>
+ </table>
+ </section>
+ </body>
+</document>
+ </j:file>
+ </goal>
</project>
Index: project.xml
===================================================================
RCS file: /cvsroot/htmlunit/htmlunit/project.xml,v
retrieving revision 1.22
retrieving revision 1.23
diff -u -d -r1.22 -r1.23
--- project.xml 29 Jun 2003 13:27:46 -0000 1.22
+++ project.xml 3 Jul 2003 19:29:51 -0000 1.23
@@ -110,87 +110,147 @@
<id>junit</id>
<version>3.8.1</version>
<url>http://www.junit.org/</url>
+ <properties>
+ <htmlunit.group>test</htmlunit.group>
+ <htmlunit.description>JUnit testing framework</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>junitperf</id>
<version>1.8</version>
<url>http://www.clarkware.com</url>
+ <properties>
+ <htmlunit.group>test</htmlunit.group>
+ <htmlunit.description>Additional support for testing</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-jelly</id>
<version>SNAPSHOT</version>
<url>http://jakarta.apache.org/commons/jelly</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>Jelly itself</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-jelly+tags-log</id>
<version>SNAPSHOT</version>
<url>http://jakarta.apache.org/commons/jelly</url>
+ <properties>
+ <htmlunit.group>Jelly</htmlunit.group>
+ <htmlunit.description>Jelly tags for logging</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-jexl</id>
<version>SNAPSHOT</version>
<url>http://jakarta.apache.org/commons/jexl</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>Expression language</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-cli</id>
<version>SNAPSHOT</version>
<url>http://jakarta.apache.org/commons/cli</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>Command line interface</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>dom4j</id>
<version>1.4-dev-8</version>
<url>http://www.dom4j.org/</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>XML DOM wrapper</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-collections</id>
<version>2.1</version>
<url>http://jakarta.apache.org/commons/collections.html</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>Collection classes</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-beanutils</id>
<version>1.6.1</version>
<url>http://jakarta.apache.org/commons/beanutils</url>
+ <properties>
+ <htmlunit.group>jelly</htmlunit.group>
+ <htmlunit.description>Javabean support</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-httpclient</id>
- <version>2.0-alpha3</version>
+ <version>2.0-beta2</version>
<url>http://jakarta.apache.org/commons/httpclient</url>
+ <properties>
+ <htmlunit.group>required</htmlunit.group>
+ <htmlunit.description>Provides the actual http support</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>gsbase</id>
<version>2.0</version>
<url>http://gsbase.sourceforge.net</url>
+ <properties>
+ <htmlunit.group>test</htmlunit.group>
+ <htmlunit.description>Misc testing support classes</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>rhino</id>
<version>1.5R4-RC3</version>
<url>http://www.mozilla.org/rhino</url>
<jar>js-1.5R4-RC3.jar</jar>
+ <properties>
+ <htmlunit.group>optional</htmlunit.group>
+ <htmlunit.description>Needed for javascript support</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>xerces</id>
- <version>2.0.2</version>
- <url>http://xml.apache.org/xercesj</url>
- <jar>xercesImpl-2.0.2.jar</jar>
- </dependency>
- <dependency>
- <id>xerces</id>
- <version>2.0.2</version>
- <url>http://xml.apache.org/xercesj</url>
- <jar>xmlParserAPIs-2.0.2.jar</jar>
+ <version>2.4.0</version>
+ <url>http://xml.apache.org/xerces2-j/index.html</url>
+ <jar>xercesImpl-2.4.0.jar</jar>
+ <properties>
+ <htmlunit.group>required</htmlunit.group>
+ <htmlunit.description>XML Parser</htmlunit.description>
+ </properties>
</dependency>
<dependency>
- <id>xml-apis</id>
- <version>2.0.2</version>
+ <id>xerces+parserAPIs</id>
+ <version>2.2.1</version>
+ <url>http://xml.apache.org/xerces2-j/index.html</url>
+ <jar>xmlParserAPIs-2.2.1.jar</jar>
+ <properties>
+ <htmlunit.group>required</htmlunit.group>
+ <htmlunit.description>XML Parser</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>nekohtml</id>
<version>0.7.6</version>
+ <properties>
+ <htmlunit.group>required</htmlunit.group>
+ <htmlunit.description>Converts html into an XML DOM model</htmlunit.description>
+ </properties>
</dependency>
<dependency>
<id>commons-logging</id>
<version>1.0.2</version>
<url>http://jakarta.apache.org/commons/logging.html</url>
+ <properties>
+ <htmlunit.group>required</htmlunit.group>
+ <htmlunit.description>Logging support</htmlunit.description>
+ </properties>
</dependency>
</dependencies>
Index: index.xml
===================================================================
RCS file: /cvsroot/htmlunit/htmlunit/src/xdocs/index.xml,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -d -r1.26 -r1.27
--- index.xml 3 May 2003 23:31:28 -0000 1.26
+++ index.xml 3 Jul 2003 19:29:51 -0000 1.27
@@ -1,5 +1,5 @@
<?xml version="1.0"?>
-<document>
+<document xmlns:j="jelly:core">
<properties>
<title>Welcome to HtmlUnit</title>
@@ -30,6 +30,11 @@
framework such as <a href="http://www.junit.org">JUnit</a>. Refer to the document
"<a href="gettingStarted.html">Getting Started with HtmlUnit</a>" for an introduction.
</p>
+ <p>
+ NOTE: This documentation is for the current code in CVS and may not accurately
+ reflect the version of HtmlUnit that you have downloaded. Refer to the
+ documentation that came with your download for the most correct information
+ </p>
</section>
<section name="Where to find...">
@@ -129,46 +134,8 @@
<section name="Installation">
<p>
- Place the following jar files in your classpath. All of these can be found in the lib directory
- of the HtmlUnit installation.
- </p>
- <p>
- <dl>
- <dt>HtmlUnit.jar</dt>
- <dd>The main HtmlUnit classes</dd>
-
- <dt>commons-httpclient.jar <version-string>2.0beta3</version-string></dt>
- <dd><a href="http://jakarta.apache.org/commons/httpclient/">HttpClient from Apache</a>,
- the code that actually handles the http connections. Note that commons-httpclient
- is going through active development and does not have a stable release yet. We're
- using periodic "daily snapshots" which are actually quite solid.</dd>
-
- <dt>commons-logging.jar <version-string>1.0.2</version-string></dt>
- <dd><a href="http://jakarta.apache.org/commons/logging.html">Logging
- from Apache</a></dd>
-
- <dt>nekohtml.jar <version-string>0.7.5 + private fix</version-string></dt>
- <dd><a href="http://www.apache.org/~andyc/neko/doc/html/index.html">
- NekoHTML</a> is a tool to convert badly written html into an xml
- dom model</dd>
-
- <dt>xercesImpl.jar and xmlParserAPIs.jar <version-string>2.2.1</version-string></dt>
- <dd>The<a href="http://xml.apache.org/xerces2-j/index.html">
- Xerces</a> xml parser from Apache. </dd>
-
- <dt>js.jar <version-string>1.5R4</version-string></dt>
- <dd><a href="http://www.mozilla.org/rhino">Rhino</a>,
- a javascript engine from the Mozilla project. This jar is optional - if it isn't
- found then javascript support will be disabled but the rest of HtmlUnit will
- continue to work.</dd>
-
- </dl>
- <note>
- If you want to use HTTPS (Secure HTTP) then you will have to have the JSSE in your
- classpath. JSSE is a standard part of Java starting with JDK1.4. If you are using
- an earlier version of Java, then you can
- <a href="http://java.sun.com/products/jsse">download</a> the JSSE from the Sun website.
- </note>
+ Place <a href="dependencies.html">all the required jars</a> in your classpath.
+ All of these can be found in the lib directory of the HtmlUnit installation.
</p>
</section>
|
