index.xml.vm revision 01014a5d9a5f07682c251ef5492e8aa9f46c21a0
826N/A<?xml version="1.0" encoding="UTF-8"?>
961N/A<!--
961N/A ! CCPL HEADER START
961N/A !
961N/A ! This work is licensed under the Creative Commons
961N/A ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
961N/A ! To view a copy of this license, visit
961N/A ! http://creativecommons.org/licenses/by-nc-nd/3.0/
961N/A ! or send a letter to Creative Commons, 444 Castro Street,
961N/A ! Suite 900, Mountain View, California, 94041, USA.
961N/A !
961N/A ! You can also obtain a copy of the license at
961N/A ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
961N/A ! See the License for the specific language governing permissions
961N/A ! and limitations under the License.
961N/A !
961N/A ! If applicable, add the following below this CCPL HEADER, with the fields
961N/A ! enclosed by brackets "[]" replaced with your own identifying information:
961N/A ! Portions Copyright [yyyy] [name of copyright owner]
961N/A !
961N/A ! CCPL HEADER END
961N/A !
961N/A ! Copyright 2013 ForgeRock AS
961N/A !
961N/A-->
961N/A<document xmlns="http://maven.apache.org/XDOC/2.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
826N/A xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
826N/A <properties>
826N/A <title>About ${project.name}</title>
826N/A <author email="opendj-dev@forgerock.org">${project.organization.name}</author>
826N/A </properties>
961N/A <body>
826N/A <section name="About ${project.name}">
826N/A <p>
826N/A ${project.description}
1295N/A </p>
826N/A </section>
961N/A <section name="Documentation for ${project.name}">
<p>
Javadoc for this module can be found <a href="apidocs/index.html">here</a>.
</p>
</section>
<section name="Get ${project.name}">
<p>
Start developing your applications by obtaining ${project.name}
using any of the following methods:
</p>
<subsection name="Maven">
<p>
By far the simplest method is to develop your application using Maven
and add the following settings to your <b>pom.xml</b>:
</p>
<source>&lt;repositories>
&lt;repository>
&lt;id>forgerock-staging-repository&lt;/id>
&lt;name>ForgeRock Release Repository&lt;/name>
&lt;url>${mavenRepoReleases}&lt;/url>
&lt;snapshots>
&lt;enabled>false&lt;/enabled>
&lt;/snapshots>
&lt;/repository>
&lt;repository>
&lt;id>forgerock-snapshots-repository&lt;/id>
&lt;name>ForgeRock Snapshot Repository&lt;/name>
&lt;url>${mavenRepoSnapshots}&lt;/url>
&lt;releases>
&lt;enabled>false&lt;/enabled>
&lt;/releases>
&lt;/repository>
&lt;/repositories>
...
&lt;dependencies>
&lt;dependency>
&lt;groupId>${project.groupId}&lt;/groupId>
&lt;artifactId>${project.artifactId}&lt;/artifactId>
&lt;version>${project.version}&lt;/version>
&lt;/dependency>
&lt;/dependencies></source>
</subsection>
<subsection name="Download">
<p>
If you are not using Maven then you will need to download a pre-built
binary from the ForgeRock Maven repository, along with any compile
time <a href="dependencies.html">dependencies</a>:
</p>
<ul>
<li><a href="${mavenRepoReleases}/org/forgerock/opendj/${project.artifactId}">Stable releases</a></li>
<li><a href="${mavenRepoSnapshots}/org/forgerock/opendj/${project.artifactId}/${project.version}">Latest development snapshot</a></li>
</ul>
</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>
<section name="Getting started">
<p>
The following example shows how ${project.name} may be used:
</p>
<source>TODO</source>
</section>
</body>
</document>