From 6d6618c34ded63aef1cb0bb8641a89b497cb2a60 Mon Sep 17 00:00:00 2001
From: Matthew Swift <matthew.swift@forgerock.com>
Date: Wed, 25 May 2011 23:43:45 +0000
Subject: [PATCH] Add OpenDJ LDAP SDK Examples module site.
---
opendj3/opendj-ldap-sdk-examples/pom.xml | 12 ++++
opendj3/opendj-ldap-sdk-examples/src/site/xdoc/index.xml | 57 ++++++++++++++++++-
opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml | 10 --
opendj3/opendj-ldap-sdk/src/site/site.xml | 11 +++
opendj3/opendj-ldap-sdk-examples/src/site/site.xml | 37 +++++++++++-
opendj3/src/site/site.xml | 7 ++
opendj3/pom.xml | 2
7 files changed, 118 insertions(+), 18 deletions(-)
diff --git a/opendj3/opendj-ldap-sdk-examples/pom.xml b/opendj3/opendj-ldap-sdk-examples/pom.xml
index 234eccd..f3dcdb1 100644
--- a/opendj3/opendj-ldap-sdk-examples/pom.xml
+++ b/opendj3/opendj-ldap-sdk-examples/pom.xml
@@ -119,6 +119,18 @@
</reportSet>
</reportSets>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-jxr-plugin</artifactId>
+ <version>2.2</version>
+ <reportSets>
+ <reportSet>
+ <reports>
+ <report>jxr</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
</plugins>
</reporting>
</project>
\ No newline at end of file
diff --git a/opendj3/opendj-ldap-sdk-examples/src/site/site.xml b/opendj3/opendj-ldap-sdk-examples/src/site/site.xml
index 2b7b9e0..04488ea 100644
--- a/opendj3/opendj-ldap-sdk-examples/src/site/site.xml
+++ b/opendj3/opendj-ldap-sdk-examples/src/site/site.xml
@@ -27,10 +27,40 @@
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/DECORATION/1.0.1 http://maven.apache.org/xsd/decoration-1.0.1.xsd">
<body>
- <menu ref="parent" />
- <menu ref="reports" />
+ <menu name="OpenDJ LDAP SDK Examples">
+ <item name="Welcome" href="index.html" />
+ <item name="News" href="../news.html" />
+ <item name="Join"
+ href="https://idp.forgerock.org/openam/UI/Login?service=register" />
+ <item name="Downloads" href="http://www.forgerock.com/downloads-opendj.html" />
+ <item name="FAQ" href="../faq.html" />
+ <item name="Mailing List" href="https://lists.forgerock.org/mailman/listinfo/opendj" />
+ <item name="Support" href="http://forgerock.com/subscriptions.html" />
+ <item name="Partners" href="http://forgerock.com/partners.html" />
+ <item name="Wiki" href="http://wikis.forgerock.org/opendj/" />
+ </menu>
+
+ <menu name="Documentation">
+ <item name="Developer Guide" href="../docs.html" collapse="true">
+ <item name="EPUB Format" href="../doc/OpenDJ-Dev-Guide.epub" />
+ <item name="HTML Format" href="../doc/dev-guide/OpenDJ-Dev-Guide.html" />
+ <item name="PDF Format" href="../doc/OpenDJ-Dev-Guide.pdf" />
+ <item name="RTF Format" href="../doc/OpenDJ-Dev-Guide.rtf" />
+ </item>
+ <item name="Javadoc" href="apidocs/index.html" />
+ <item name="Source code XREF" href="xref/index.html" />
+ </menu>
+
+ <menu name="Project Information">
+ <item name="Continuous Integration" href="integration.html" />
+ <item name="Maven Repository" href="distribution-management.html" />
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="License" href="license.html" />
+ <item name="Source Repository" href="source-repository.html" />
+ </menu>
</body>
-
+
<custom>
<googleAnalytics>UA-23412190-2</googleAnalytics>
<openproject>
@@ -40,3 +70,4 @@
</openproject>
</custom>
</project>
+
diff --git a/opendj3/opendj-ldap-sdk-examples/src/site/xdoc/index.xml b/opendj3/opendj-ldap-sdk-examples/src/site/xdoc/index.xml
index 57d5c12..952170a 100644
--- a/opendj3/opendj-ldap-sdk-examples/src/site/xdoc/index.xml
+++ b/opendj3/opendj-ldap-sdk-examples/src/site/xdoc/index.xml
@@ -26,13 +26,64 @@
<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
<properties>
- <title>About OpenDJ</title>
+ <title>About OpenDJ LDAP SDK Examples</title>
<author email="opendj-dev@forgerock.org">ForgeRock AS</author>
</properties>
<body>
<section name="About OpenDJ LDAP SDK Examples">
- <p>TBC</p>
+ <p>This module contains 5 example LDAP applications implemented using the
+ OpenDJ LDAP SDK:</p>
+ <ul>
+ <li>
+ <a href="xref/org/forgerock/opendj/examples/search/Main.html">LDAP search</a>
+ - illustrates how to perform an LDAP search operation using the
+ synchronous APIs
+ </li>
+ <li>
+ <a href="xref/org/forgerock/opendj/examples/searchasync/Main.html">LDAP asynchronous search</a>
+ - illustrates how to perform an LDAP search operation using the
+ asynchronous APIs
+ </li>
+ <li>
+ <a href="xref/org/forgerock/opendj/examples/modify/Main.html">LDAP modify</a>
+ - illustrates how to perform an LDAP modify operation using the
+ synchronous APIs
+ </li>
+ <li>
+ <a href="xref/org/forgerock/opendj/examples/server/Main.html">LDAP server</a>
+ - illustrates how to implement a very simple LDAP server
+ </li>
+ <li>
+ <a href="xref/org/forgerock/opendj/examples/proxy/Main.html">LDAP proxy</a>
+ - illustrates how to implement a very simple LDAP proxy
+ </li>
+ </ul>
+ </section>
+ <section name="Get the OpenDJ LDAP SDK Examples">
+ <p>
+ You can get the
+ OpenDJ
+ LDAP SDK examples using any of the following
+ methods:
+ </p>
+ <subsection name="Download">
+ <p>
+ The easiest way to download the OpenDJ LDAP SDK Examples and all of
+ its
+ dependencies is to get the latest version from our
+ <a
+ href="http://maven.forgerock.org/repo/snapshots/org/forgerock/opendj/opendj-ldap-sdk-examples/3.0.0-SNAPSHOT">repository</a>
+ .
+ </p>
+ </subsection>
+ <subsection name="Build">
+ <p>
+ For the DIY enthusiasts you can build it yourself by checking out the
+ latest code using
+ <a href="source-repository.html">Subversion</a>
+ and building it with Maven 3
+ </p>
+ </subsection>
</section>
</body>
</document>
-
diff --git a/opendj3/opendj-ldap-sdk/src/site/site.xml b/opendj3/opendj-ldap-sdk/src/site/site.xml
index d127f16..66303f0 100644
--- a/opendj3/opendj-ldap-sdk/src/site/site.xml
+++ b/opendj3/opendj-ldap-sdk/src/site/site.xml
@@ -47,10 +47,17 @@
<item name="PDF Format" href="../doc/OpenDJ-Dev-Guide.pdf" />
<item name="RTF Format" href="../doc/OpenDJ-Dev-Guide.rtf" />
</item>
- <item name="Javadoc" href="./apidocs/index.html" />
+ <item name="Javadoc" href="apidocs/index.html" />
</menu>
- <menu ref="reports" />
+ <menu name="Project Information">
+ <item name="Continuous Integration" href="integration.html" />
+ <item name="Maven Repository" href="distribution-management.html" />
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="License" href="license.html" />
+ <item name="Source Repository" href="source-repository.html" />
+ </menu>
</body>
<custom>
diff --git a/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml b/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml
index a7059b9..c282e13 100644
--- a/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml
+++ b/opendj3/opendj-ldap-sdk/src/site/xdoc/index.xml
@@ -58,7 +58,7 @@
<p>
You can start developing your LDAP applications now by obtaining the
OpenDJ
- LDAP SDK in any of the following three ways:
+ LDAP SDK using any of the following methods:
</p>
<subsection name="Maven">
<p>
@@ -170,13 +170,7 @@
}
}</source>
<p>
- You can find more examples demonstrating the use of the OpenDJ LDAP SDK
- by downloading the examples package
- <a
- href="http://maven.forgerock.org/repo/snapshots/org/forgerock/opendj/opendj-ldap-sdk-examples/3.0.0-SNAPSHOT">
- here
- </a>
- .
+ You can find more examples in the <a href="../opendj-ldap-sdk-examples/index.html">OpenDJ LDAP SDK Examples</a> module.
</p>
</section>
</body>
diff --git a/opendj3/pom.xml b/opendj3/pom.xml
index 2be9414..7b104ff 100644
--- a/opendj3/pom.xml
+++ b/opendj3/pom.xml
@@ -118,7 +118,7 @@
<goal>generate-manpages</goal>
</goals>
<configuration>
- <sourceDirectory>${basedir}/src/main/docbkx</sourceDirectory>
+ <sourceDirectory>${basedir}/src/main/docbkx</sourceDirectory>
<!-- Comment the draft elements out for final build -->
<draftMode>yes</draftMode>
<draftWatermarkImage>http://docbook.sourceforge.net/release/images/draft.png</draftWatermarkImage>
diff --git a/opendj3/src/site/site.xml b/opendj3/src/site/site.xml
index 2815f9e..51b7de7 100644
--- a/opendj3/src/site/site.xml
+++ b/opendj3/src/site/site.xml
@@ -91,7 +91,12 @@
<item name="SDK Javadoc" href="./opendj-ldap-sdk/apidocs/index.html" />
</menu>
- <menu ref="reports" />
+ <menu name="Project Information">
+ <item name="Issue Tracking" href="issue-tracking.html" />
+ <item name="Mailing Lists" href="mail-lists.html" />
+ <item name="License" href="license.html" />
+ <item name="Source Repository" href="source-repository.html" />
+ </menu>
</body>
--
Gitblit v1.10.0