From f910a72616be79c9ff4ddbb8484aea00fe83392a Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 21 Jun 2013 05:43:45 +0000
Subject: [PATCH] CR-1880 Fix for OPENDJ-987: Determine what to do with links to http://opendj.forgerock.org/
---
opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml | 2 +-
opendj3/src/main/docbkx/shared/man-dsconfig.xml | 7 +++----
opendj3/src/main/docbkx/admin-guide/chap-server-process.xml | 2 +-
opends/resource/man/man1/dsconfig.1 | 16 ++++++++--------
opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml | 2 +-
opendj3/pom.xml | 27 ++++++++++++++++++++++++++-
6 files changed, 40 insertions(+), 16 deletions(-)
diff --git a/opendj3/pom.xml b/opendj3/pom.xml
index 6956462..9e210f1 100644
--- a/opendj3/pom.xml
+++ b/opendj3/pom.xml
@@ -21,7 +21,7 @@
!
! CDDL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2013 ForgeRock AS
!
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
@@ -130,8 +130,32 @@
<softwareReleaseDate>${releaseDate}</softwareReleaseDate>
<checkstyleHeaderLocation>org/forgerock/checkstyle/opendj-java-header</checkstyleHeaderLocation>
<frDocPluginVersion>1.2.0</frDocPluginVersion>
+
+ <!-- Permit doc build to override relative locations of non DocBook content -->
+ <configRefBase>http://opendj.forgerock.org/opendj-server/configref/</configRefBase>
+ <serverJavadocBase>http://opendj.forgerock.org/opendj-server/javadoc/</serverJavadocBase>
+ <sdkJavadocBase>http://opendj.forgerock.org/opendj-ldap-sdk/apidocs/</sdkJavadocBase>
</properties>
<build>
+
+ <!-- Filter XML to allow ${property} in attribute values. -->
+ <resources>
+ <resource>
+ <directory>src/main/docbkx</directory>
+ <filtering>true</filtering>
+ <includes>
+ <include>**/*.xml</include>
+ </includes>
+ </resource>
+ <resource>
+ <directory>src/main/docbkx</directory>
+ <filtering>false</filtering>
+ <excludes>
+ <exclude>**/*.xml</exclude>
+ </excludes>
+ </resource>
+ </resources>
+
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
@@ -165,6 +189,7 @@
<version>${frDocPluginVersion}</version>
<inherited>false</inherited>
<configuration>
+ <docbkxSourceDirectory>target/classes</docbkxSourceDirectory> <!-- Use filtered XML -->
<projectName>OpenDJ</projectName>
<googleAnalyticsId>${gaId}</googleAnalyticsId>
</configuration>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
index bdb583c..76d9255 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -240,7 +240,7 @@
<para>In addition to the <link xlink:href="admin-guide#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink">dsconfig</link> reference
that covers subcommands, the <link xlink:show="new"
- xlink:href="http://opendj.forgerock.org/opendj-server/configref/index.html"
+ xlink:href="${configRefBase}"
><citetitle>Configuration Reference</citetitle></link> covers the
properties you can set using the <command>dsconfig</command>
command.</para>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml b/opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml
index 92a8a86..a5be6e5 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-pwd-policy.xml
@@ -113,7 +113,7 @@
<para>See the <citetitle>OpenDJ Configuration Reference</citetitle> page
on <link xlink:show="new"
- xlink:href="http://opendj.forgerock.org/opendj-server/configref/password-policy.html"
+ xlink:href="${configRefBase}password-policy.html"
><citetitle>Password Policy</citetitle></link> for detailed descriptions of
each property.</para>
diff --git a/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml b/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
index 2014fab..2995ab3 100644
--- a/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opendj3/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -178,7 +178,7 @@
content into memory when the server starts. Objects cached in memory do not
survive a crash. By default, OpenDJ does not cache objects in memory before
starting to accept client requests. You can however set a
- <link xlink:href="http://opendj.forgerock.org/opendj-server/configref/local-db-backend.html#preload-time-limit"
+ <link xlink:href="${configRefBase}local-db-backend.html#preload-time-limit"
><literal>preload-time-limit</literal></link> for the database cache of your
backend if you do want to load objects into the database cache before
OpenDJ begins accepting client connections.</para>
diff --git a/opendj3/src/main/docbkx/shared/man-dsconfig.xml b/opendj3/src/main/docbkx/shared/man-dsconfig.xml
index 65e84b4..c5a7b5f 100644
--- a/opendj3/src/main/docbkx/shared/man-dsconfig.xml
+++ b/opendj3/src/main/docbkx/shared/man-dsconfig.xml
@@ -89,8 +89,8 @@
component's <literal>allow-start-tls</literal> property to
<literal>true</literal> to permit LDAP client applications to use StartTLS.
Much of the configuration you do with <command>dsconfig</command> involves
- setting component properties. The <link
- xlink:href="http://opendj.forgerock.org/opendj-server/configref/index.html"
+ setting component properties. The <link xlink:show="new"
+ xlink:href="${configRefBase}"
><citetitle>OpenDJ Configuration Reference</citetitle></link> covers all
<command>dsconfig</command> component properties in detail, drawing on the
documentation you also view when getting help through the
@@ -375,8 +375,7 @@
</itemizedlist>
<para>Component properties for the <command>dsconfig</command> command are
- covered in the <link
- xlink:href="http://opendj.forgerock.org/opendj-server/configref/index.html"
+ covered in the <link xlink:show="new" xlink:href="${configRefBase}"
><citetitle>OpenDJ Configuration Reference</citetitle></link>.</para>
<para>Many subcommands let you set property values. Notice in the reference
diff --git a/opends/resource/man/man1/dsconfig.1 b/opends/resource/man/man1/dsconfig.1
index 8959499..48486c8 100644
--- a/opends/resource/man/man1/dsconfig.1
+++ b/opends/resource/man/man1/dsconfig.1
@@ -2,12 +2,12 @@
.\" Title: dsconfig
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 05/16/2013
+.\" Date: 06/19/2013
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.6.0
.\" Language: English
.\"
-.TH "DSCONFIG" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
+.TH "DSCONFIG" "1" "06/19/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -518,7 +518,7 @@
.PP
\fB\-t | \-\-type {type}\fR
.RS 4
-The type of Attribute Syntax which should be created (Default: generic)\&. The value for TYPE can be one of: attribute\-type\-description | directory\-string | generic | telephone\-number
+The type of Attribute Syntax which should be created (Default: generic)\&. The value for TYPE can be one of: attribute\-type\-description | certificate | country\-string | directory\-string | generic | jpeg | telephone\-number
.RE
.SS "dsconfig create\-backend"
.PP
@@ -572,7 +572,7 @@
.PP
\fB\-t | \-\-type {type}\fR
.RS 4
-The type of Connection Handler which should be created\&. The value for TYPE can be one of: custom | jmx | ldap | ldif | snmp
+The type of Connection Handler which should be created\&. The value for TYPE can be one of: custom | http | jmx | ldap | ldif | snmp
.RE
.SS "dsconfig create\-debug\-target"
.PP
@@ -749,7 +749,7 @@
.PP
\fB\-t | \-\-type {type}\fR
.RS 4
-The type of Log Publisher which should be created\&. The value for TYPE can be one of: custom\-access | custom\-debug | custom\-error | file\-based\-access | file\-based\-audit | file\-based\-debug | file\-based\-error
+The type of Log Publisher which should be created\&. The value for TYPE can be one of: custom\-access | custom\-debug | custom\-error | custom\-http\-access | file\-based\-access | file\-based\-audit | file\-based\-debug | file\-based\-error | file\-based\-http\-access
.RE
.SS "dsconfig create\-log\-retention\-policy"
.PP
@@ -875,7 +875,7 @@
.PP
\fB\-t | \-\-type {type}\fR
.RS 4
-The type of Password Storage Scheme which should be created\&. The value for TYPE can be one of: aes | base64 | blowfish | clear | crypt | custom | md5 | rc4 | salted\-md5 | salted\-sha1 | salted\-sha256 | salted\-sha384 | salted\-sha512 | sha1 | triple\-des
+The type of Password Storage Scheme which should be created\&. The value for TYPE can be one of: aes | base64 | blowfish | clear | crypt | custom | md5 | pbkdf2 | rc4 | salted\-md5 | salted\-sha1 | salted\-sha256 | salted\-sha384 | salted\-sha512 | sha1 | triple\-des
.RE
.SS "dsconfig create\-password\-validator"
.PP
@@ -1024,7 +1024,7 @@
.PP
\fB\-t | \-\-type {type}\fR
.RS 4
-The type of Virtual Attribute which should be created\&. The value for TYPE can be one of: collective\-attribute\-subentries | custom | entry\-dn | entry\-uuid | governing\-structure\-rule | has\-subordinates | is\-member\-of | member | num\-subordinates | password\-policy\-subentry | structural\-object\-class | subschema\-subentry | user\-defined
+The type of Virtual Attribute which should be created\&. The value for TYPE can be one of: collective\-attribute\-subentries | custom | entity\-tag | entry\-dn | entry\-uuid | governing\-structure\-rule | has\-subordinates | is\-member\-of | member | num\-subordinates | password\-expiration\-time | password\-policy\-subentry | structural\-object\-class | subschema\-subentry | user\-defined
.RE
.SS "dsconfig delete\-access\-log\-filtering\-criteria"
.PP
@@ -4418,5 +4418,5 @@
itself, and include the bind password for the administrative user (or replace that option with an alternative, such as reading the password from a file)\&.
.SH "COPYRIGHT"
.br
-Copyright \(co 2011-2012 ForgeRock AS
+Copyright \(co 2011-2013 ForgeRock AS
.br
--
Gitblit v1.10.0