(no commit message)

[utils] / support / general / src / site / xdoc / index.xml
diff --git a/support/general/src/site/xdoc/index.xml b/support/general/src/site/xdoc/index.xml

index ff5261e1566268c660e852107276d0df6181217f..f37b6accdeb27c777bfe34d255006540622ee496 100644 (file)
--- a/support/general/src/site/xdoc/index.xml
+++ b/support/general/src/site/xdoc/index.xml
@@ -4,13 +4,56 @@
    xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
    
    <properties>
-    <title>overview</title>
+    <title>user guide</title>
      <author email="erik@brakkee.org">Erik Brakkee</author>
    </properties>
    <body>
-    <section name="Introduction">
-      <p>The general support library contains various smaller utilities that
-         can be useful for any java project. </p>
+    <section name="Overview">
+      <p>The general support library contains various smaller utilities that can be useful for any
+        java project. Utilities are available in the following areas:</p>
+      <ul>
+        <li><a href="apidocs/org/wamblee/cache/package-summary.html">Caching</a></li>
+        <li><a href="apidocs/org/wamblee/classloading/package-summary.html">Classloading</a></li>
+        <li><a href="apidocs/org/wamblee/conditions/package-summary.html">Conditions</a></li>
+        <li><a href="apidocs/org/wamblee/collections/package-summary.html">Collections</a></li>
+        <li><a href="apidocs/org/wamblee/concurrency/package-summary.html">Concurrency</a></li>
+        <li><a href="apidocs/org/wamblee/general/package-summary.html">General</a></li>
+        <li><a href="apidocs/org/wamblee/io/package-summary.html">IO</a></li>
+               <li><a href="apidocs/org/wamblee/ioc/package-summary.html">IOC</a></li>
+        <li><a href="apidocs/org/wamblee/observer/package-summary.html">Observer</a></li>
+        <li><a href="apidocs/org/wamblee/persistence/package-summary.html">Persistence</a></li>
+        <li><a href="apidocs/org/wamblee/reflection/package-summary.html">Reflection</a></li>
+        <li><a href="apidocs/org/wamblee/xml/package-summary.html">XML</a></li>
+      </ul>
      </section>
+
+    <section name="Maven POM configuration">
+      <p>The following maven dependency must be used:</p>
+      <table>
+        <tr>
+          <th>groupId</th>
+          <th>artifactId</th>
+        </tr>
+        <tr>
+          <td>org.wamblee</td>
+          <td>wamblee-support-general</td>
+        </tr>
+      </table>
+      <p>In addition there are optional dependencies on the following maven artifacts that need only
+      be used when EhCache utlities are used: </p>
+      <table>
+        <tr>
+          <th>groupId</th>
+          <th>artifactId</th>
+          <th>version</th>
+        </tr>
+        <tr>
+          <td>net.sf.ehcache</td>
+          <td>ehcache-core</td>
+          <td>2.2.0</td>
+        </tr>
+      </table>
+    </section>
+
    </body>
  </document>