From 64d43ef5b74c308f6903c64e71c7fb471634a968 Mon Sep 17 00:00:00 2001
From: Michael Smith <xmldoc@users.sourceforge.net>
Date: Sat, 18 Aug 2007 10:19:00 +0000
Subject: [PATCH] Changed handling of HTML output for the cmdsynopsis and
 funcsynopsis elements, such that a@id instances are generated for them if
 they are descendants of any element containing a dbcmdlist or dbfunclist PI.
 Also, update the embedded reference docs for the dbcmdlist and dbfunclist PIs
 to make it clear that they can be used within any element for which
 cmdsynopsis or funcsynopsis are valid children.

---
 xsl/html/pi.xsl    | 16 ++++++++--------
 xsl/html/synop.xsl | 25 ++++++++++++++++++++++---
 2 files changed, 30 insertions(+), 11 deletions(-)

diff --git a/xsl/html/pi.xsl b/xsl/html/pi.xsl
index 6a75f7c05..69570f1a0 100644
--- a/xsl/html/pi.xsl
+++ b/xsl/html/pi.xsl
@@ -897,12 +897,12 @@
 <doc:pi name="dbcmdlist" xmlns="">
   <refpurpose>Generates a hyperlinked list of commands</refpurpose>
   <refdescription>
-    <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of a
-      <tag>refsynopsisdiv</tag> containing multiple
+    <para>Use the <tag class="xmlpi">dbcmdlist</tag> PI as the child of any
+      element (for example, <tag>refsynopsisdiv</tag>) containing multiple
       <tag>cmdsynopsis</tag> instances; a hyperlinked navigational
-      “command list” will be generated at the top of the
-      <tag>refsynopsisdiv</tag>, enabling users to quickly jump
-      to to each command synopsis.</para>
+      “command list” will be generated at the top of output for that
+      element, enabling users to quickly jump
+      to each command synopsis.</para>
   </refdescription>
   <refsynopsisdiv>
     <synopsis><tag class="xmlpi">dbcmdlist</tag></synopsis>
@@ -927,11 +927,11 @@
 <doc:pi name="dbfunclist" xmlns="">
   <refpurpose>Generates a hyperlinked list of functions</refpurpose>
   <refdescription>
-    <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of a
-      <tag>refsynopsisdiv</tag> containing multiple
+    <para>Use the <tag class="xmlpi">dbfunclist</tag> PI as the child of any
+      element (for example, <tag>refsynopsisdiv</tag>) containing multiple
       <tag>funcsynopsis</tag> instances; a hyperlinked
       navigational “function list” will be generated at the top of
-      the <tag>refsynopsisdiv</tag>, enabling users to quickly
+      output for that element, enabling users to quickly
       jump to to each function synopsis.</para>
   </refdescription>
   <refsynopsisdiv>
diff --git a/xsl/html/synop.xsl b/xsl/html/synop.xsl
index 3ce59965c..cd6bfc734 100644
--- a/xsl/html/synop.xsl
+++ b/xsl/html/synop.xsl
@@ -25,9 +25,17 @@
   <div>
     <xsl:apply-templates select="." mode="class.attribute"/>
     <p>
-      <xsl:call-template name="anchor">
-        <xsl:with-param name="conditional" select="0"/>
-      </xsl:call-template>
+      <xsl:if test="..//processing-instruction('dbcmdlist')">
+        <!-- * Placing a dbcmdlist PI as a child of a particular element -->
+        <!-- * creates a hyperlinked list of all cmdsynopsis instances -->
+        <!-- * that are descendants of that element; so for any -->
+        <!-- * cmdsynopsis that is a descendant of an element containing -->
+        <!-- * a dbcmdlist PI, we need to output an a@id instance so that -->
+        <!-- * we will have something to link to -->
+        <xsl:call-template name="anchor">
+          <xsl:with-param name="conditional" select="0"/>
+        </xsl:call-template>
+      </xsl:if>
       <xsl:apply-templates/>
     </p>
   </div>
@@ -157,6 +165,17 @@
 </xsl:template>
 
 <xsl:template match="funcsynopsis">
+  <xsl:if test="..//processing-instruction('dbfunclist')">
+    <!-- * Placing a dbfunclist PI as a child of a particular element -->
+    <!-- * creates a hyperlinked list of all funcsynopsis instances that -->
+    <!-- * are descendants of that element; so for any funcsynopsis that is -->
+    <!-- * a descendant of an element containing a dbfunclist PI, we need -->
+    <!-- * to output an a@id instance so that we will have something to -->
+    <!-- * link to -->
+    <xsl:call-template name="anchor">
+      <xsl:with-param name="conditional" select="0"/>
+    </xsl:call-template>
+  </xsl:if>
   <xsl:call-template name="informal.object"/>
 </xsl:template>
 
-- 
2.40.0