index.xml.vm revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! or http://forgerock.org/license/CDDLv1.0.html.
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2014-2015 ForgeRock AS.
!
-->
<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 ${project.name}</title>
<author email="opendj-dev@forgerock.org">${project.organization.name}</author>
</properties>
<body>
<section name="About ${project.name}">
<p>
${project.description}
</p>
</section>
<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>