From 3bbf0771757ebdd77a4d645e86e827f58067a28c Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 30 Sep 2011 09:31:45 +0000
Subject: [PATCH] First crack at an index, added xml:id attributes for link ends

---
 opendj3/src/main/docbkx/admin-guide/appendix-controls.xml |  159 +++++++++++++++++++++++++++++++++++++++++++---------
 1 files changed, 131 insertions(+), 28 deletions(-)

diff --git a/opendj3/src/main/docbkx/admin-guide/appendix-controls.xml b/opendj3/src/main/docbkx/admin-guide/appendix-controls.xml
index 40d289c..cd5d4c2 100644
--- a/opendj3/src/main/docbkx/admin-guide/appendix-controls.xml
+++ b/opendj3/src/main/docbkx/admin-guide/appendix-controls.xml
@@ -41,9 +41,13 @@
  <para>OpenDJ software supports the following LDAP controls.</para>
  
  <variablelist>
-  <varlistentry>
+  <varlistentry xml:id="assertion-request-control">
    <term>Assertion Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Assertion</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.1.12</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4528'>RFC 4528
     - Lightweight Directory Access Protocol (LDAP) Assertion Control</link>
@@ -51,9 +55,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="authorization-identity-request-control">
    <term>Authorization Identity Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Authorization identity</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.16</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc3829'>RFC 3829
     - Lightweight Directory Access Protocol (LDAP) Authorization Identity
@@ -61,9 +69,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="authorization-identity-response-control">
    <term>Authorization Identity Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Authorization identity</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.15</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc3829'>RFC 3829
     - Lightweight Directory Access Protocol (LDAP) Authorization Identity
@@ -71,9 +83,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="entry-change-notification-response-control">
    <term>Entry Change Notification Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Entry change notification</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.7</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-ietf-ldapext-psearch'
@@ -82,9 +98,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="get-effective-rights-request-control">
    <term>Get Effective Rights Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Get effective rights</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.2</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-ietf-ldapext-acl-model'
@@ -93,9 +113,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="manage-dsait-request-control">
    <term>Manage DSAIT Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Manage DSAIT</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.2</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc3296'>RFC 3296
     - Named Subordinate References in Lightweight Directory Access Protocol
@@ -103,9 +127,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="matched-values-request-control">
    <term>Matched Values Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Matched values</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.826.0.1.3344810.2.3</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc3876'>RFC 3876
     - Returning Matched Values with the Lightweight Directory Access Protocol
@@ -113,9 +141,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="password-expired-response-control">
    <term>Password Expired Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Password expired</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.4</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-vchu-ldap-pwd-policy'
@@ -124,9 +156,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="password-expiring-response-control">
    <term>Password Expiring Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Password expiring</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.5</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-vchu-ldap-pwd-policy'
@@ -135,9 +171,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="password-policy-response-control">
    <term>Password Policy Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Password policy</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.4.1.42.2.27.8.5.1</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-behera-ldap-password-policy'
@@ -146,9 +186,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="permissive-modify-request-control">
    <term>Permissive Modify Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Permissive modify</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.840.113556.1.4.1413</para>
     <para>Microsoft defined this control that, "Allows an LDAP modify to work
     under less restrictive conditions. Without it, a delete will fail if an
@@ -159,9 +203,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="persistent-search-request-control">
    <term>Persistent Search Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Persistent search</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.3</para>
     <para>Internet-Draft:
     <link xlink:href='http://tools.ietf.org/html/draft-ietf-ldapext-psearch'
@@ -170,9 +218,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="post-read-request-control">
    <term>Post-Read Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Post-read</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.1.13.2</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4527'>RFC 4527
     - Lightweight Directory Access Protocol (LDAP) Read Entry Controls</link>
@@ -180,19 +232,27 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="post-read-response-control">
    <term>Post-Read Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Post-read</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.1.13.2</para>
-    <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4527'>RFC 4527 
+    <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4527'>RFC 4527
     - Lightweight Directory Access Protocol (LDAP) Read Entry Controls</link>
     </para>
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="pre-read-request-control">
    <term>Pre-Read Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Pre-read</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.1.13.1</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4527'>RFC 4527
     - Lightweight Directory Access Protocol (LDAP) Read Entry Controls</link>
@@ -200,9 +260,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="pre-read-response-control">
    <term>Pre-Read Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Pre-read</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.1.13.1</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4527'>RFC 4527
     - Lightweight Directory Access Protocol (LDAP) Read Entry Controls</link>
@@ -210,9 +274,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="proxied-authorization-v1-request-control">
    <term>Proxied Authorization v1 Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Proxied authorization</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.12</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-weltman-ldapv3-proxy-04'
@@ -221,9 +289,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="proxied-autorization-v2-request-control">
    <term>Proxied Authorization v2 Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Proxied authorization</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.18</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc4370'>RFC 4370
     - Lightweight Directory Access Protocol (LDAP) Proxied Authorization
@@ -231,18 +303,26 @@
    </listitem>
   </varlistentry>
   
-  <varlistentry>
+  <varlistentry xml:id="public-changelog-exchange-control">
    <term>Public Changelog Exchange Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Public changelog exchange</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.4.1.26027.1.5.4</para>
     <para>OpenDJ specific, for using the bookmark cookie when reading
     the external change log.</para>
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="server-side-sort-request-control">
    <term>Server Side Sort Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Server side sort</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.840.113556.1.4.473</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc2891'>RFC 2891
     - LDAP Control Extension for Server Side Sorting of Search Results</link>
@@ -250,9 +330,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="server-side-sort-response-control">
    <term>Server Side Sort Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Server side sort</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.840.113556.1.4.474</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc2891'>RFC 2891
     - LDAP Control Extension for Server Side Sorting of Search Results</link>
@@ -260,9 +344,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="simple-paged-results-control">
    <term>Simple Paged Results Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Simple paged results</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.840.113556.1.4.319</para>
     <para>RFC: <link xlink:href='http://tools.ietf.org/html/rfc2696'>RFC 2696 
     - LDAP Control Extension for Simple Paged Results Manipulation</link>
@@ -270,9 +358,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="subentries-request-controls">
    <term>Subentries Request Controls</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Subentries</secondary>
+    </indexterm>
     <para>Object Identifier: 1.3.6.1.4.1.4203.1.10.1</para>
     <para>RFC: <link
     xlink:href='http://tools.ietf.org/html/rfc3672'
@@ -284,9 +376,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="subtree-delete-request-control">
    <term>Subtree Delete Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Subtree delete</secondary>
+    </indexterm>
     <para>Object Identifier: 1.2.840.113556.1.4.805</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-armijo-ldap-treedelete'
@@ -294,9 +390,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="virtual-list-view-request-control">
    <term>Virtual List View Request Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Virtual list view (browsing)</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.9</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-ietf-ldapext-ldapv3-vlv'
@@ -305,9 +405,13 @@
    </listitem>
   </varlistentry>
 
-  <varlistentry>
+  <varlistentry xml:id="virtual-list-view-response-control">
    <term>Virtual List View Response Control</term>
    <listitem>
+    <indexterm>
+     <primary>LDAP controls</primary>
+     <secondary>Virtual list view (browsing)</secondary>
+    </indexterm>
     <para>Object Identifier: 2.16.840.1.113730.3.4.10</para>
     <para>Internet-Draft: <link
     xlink:href='http://tools.ietf.org/html/draft-ietf-ldapext-ldapv3-vlv'
@@ -316,5 +420,4 @@
    </listitem>
   </varlistentry>
  </variablelist>
-
 </appendix>

--
Gitblit v1.10.0