From 1117d9d82ee0d9749723deb4b17126b2af52e1f1 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 04 Sep 2015 11:41:09 +0000
Subject: [PATCH] OPENDJ-2254 Edit OpenDJ product documentation
---
opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml | 9 ++-------
opendj-server-legacy/resource/log-message-reference.xml | 27 ++++++++++++++-------------
opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml | 7 +------
opendj-doc-maven-plugin/src/main/resources/org/forgerock/opendj/maven/doc/docs.properties | 7 +------
opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties | 5 +----
5 files changed, 19 insertions(+), 36 deletions(-)
diff --git a/opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties b/opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties
index e62227e..a2ada31 100644
--- a/opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties
+++ b/opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties
@@ -438,10 +438,7 @@
# Strings for generated reference documentation.
REF_DSCFG_ALLOW_UNLIMITED_1000=A value of "-1" or "unlimited" for no limit.
-REF_DSCFG_ACI_SYNTAX_REL_URL_1001=<link xlink:show="new" \
- xlink:href="admin-guide#about-acis" \
- xlink:role="http://docbook.org/xlink/role/olink" \
- ><citetitle>About Access Control Instructions</citetitle></link>
+REF_DSCFG_ACI_SYNTAX_REL_URL_1001=<olink targetdoc="admin-guide" targetptr="about-acis" />
REF_DSCFG_DURATION_SYNTAX_REL_URL_1002=<xinclude:include href="itemizedlist-duration.xml" />
REF_DSCFG_ARG_ADDITIONAL_INFO_1003=%s properties depend on the %s type, \
which depends on the %s option.
diff --git a/opendj-doc-maven-plugin/src/main/resources/org/forgerock/opendj/maven/doc/docs.properties b/opendj-doc-maven-plugin/src/main/resources/org/forgerock/opendj/maven/doc/docs.properties
index a2429ff..52211e3 100644
--- a/opendj-doc-maven-plugin/src/main/resources/org/forgerock/opendj/maven/doc/docs.properties
+++ b/opendj-doc-maven-plugin/src/main/resources/org/forgerock/opendj/maven/doc/docs.properties
@@ -60,12 +60,7 @@
LOG_REF_TITLE=Log Message Reference
LOG_REF_INDEXTERM=Logs
-LOG_REF_INTRO=The section on \
- <link \
- xlink:href="admin-guide#logging" \
- xlink:role="http://docbook.org/xlink/role/olink" \
- xlink:show="new" \
- ><citetitle>Server Logs</citetitle></link> describes logs. \
+LOG_REF_INTRO=<olink targetdoc="admin-guide" targetptr="logging" /> describes logs. \
Access and audit logs concern client operations \
rather than OpenDJ directory server and tools, \
and so are not listed here. \
diff --git a/opendj-server-legacy/resource/log-message-reference.xml b/opendj-server-legacy/resource/log-message-reference.xml
index c19be2a..f351f8a 100644
--- a/opendj-server-legacy/resource/log-message-reference.xml
+++ b/opendj-server-legacy/resource/log-message-reference.xml
@@ -25,25 +25,26 @@
!
-->
<appendix xml:id='appendix-log-messages'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Log Message Reference</title>
<indexterm>
<primary>Logs</primary>
<secondary>Log Message Reference</secondary>
</indexterm>
- <para>The section on <link xlink:href="admin-guide#logging"
- xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Server
- Logs</citetitle></link> describes logs. Access and audit logs concern client
- operations rather than OpenDJ directory server and tools, and so are not
- listed here. Instead, this appendix covers severe and fatal error messages
- for the directory server and its tools, such as those logged in
- <filename>/path/to/opendj/logs/errors</filename>, and
- <filename>/path/to/opendj/logs/replication</filename>.</para>
+ <para>
+ <olink targetdoc="admin-guide" targetptr="logging"/> describes logs.
+ Access and audit logs concern client operations
+ rather than OpenDJ directory server and tools, and so are not listed here.
+ Instead, this appendix covers severe and fatal error messages
+ for the directory server and its tools,
+ such as those logged in <filename>/path/to/opendj/logs/errors</filename>,
+ and <filename>/path/to/opendj/logs/replication</filename>.
+ </para>
<!-- <xinclude:include href="log-ref-access-control.xml" /> -->
<!-- <xinclude:include href="log-ref-admin-tool.xml" /> -->
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml
index 05bb1f2..51dc18c 100644
--- a/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml
@@ -28,15 +28,10 @@
version="5.0" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://docbook.org/ns/docbook
- http://docbook.org/xml/5.0/xsd/docbook.xsd"
- xmlns:xlink="http://www.w3.org/1999/xlink">
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
<title>See Also</title>
<para>
- <link xlink:show="new"
- xlink:href="reference#make-ldif-template-5"
- xlink:role="http://docbook.org/xlink/role/olink"
- ><citerefentry><refentrytitle
- >make-ldif.template</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>
+ <xref linkend="make-ldif-template-5" />
</para>
</refsect1>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml b/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml
index a09bf70..856c6e0 100644
--- a/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml
@@ -561,12 +561,7 @@
<title>See Also</title>
<para>
- <link
- xlink:show="new"
- xlink:href="reference#make-ldif-1"
- xlink:role="http://docbook.org/xlink/role/olink"
- ><citerefentry><refentrytitle
- >make-ldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
+ <xref linkend="make-ldif-1" />,
the OpenDJ directory server template file
<filename>/path/to/opendj/config/MakeLDIF/example.template</filename>
</para>
--
Gitblit v1.10.0