From: Mauritz Jeanson <mj@johanneberg.com>
Date: Thu, 9 Aug 2007 17:59:54 +0000 (+0000)
Subject: Added documentation for the dbhh PI (used for context-sensitive HTML Help).
X-Git-Tag: release/1.79.1~6^2~1809
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=753de3c8d0df9425b04fcf26ad736eb61d3c58f9;p=docbook-dsssl

Added documentation for the dbhh PI (used for context-sensitive HTML Help).
(The two templates matching 'dbhh' are still in htmlhelp-common.xsl).
---

diff --git a/xsl/html/pi.xsl b/xsl/html/pi.xsl
index 8e609bc09..f7ffe6744 100644
--- a/xsl/html/pi.xsl
+++ b/xsl/html/pi.xsl
@@ -1205,4 +1205,36 @@
   </xsl:choose>
 </xsl:template>
 
+<!-- There are two templates matching this PI in htmlhelp-common.xsl -->
+<doc:pi name="dbhh" xmlns="">
+  <refpurpose>Sets topic name and topic id for context-sensitive HTML Help</refpurpose>
+  <refdescription>
+    <para>Use the <tag class="xmlpi">dbhh</tag> PI as a child of components
+      that should be used as targets for context-sensitive help requests.</para>
+  </refdescription>
+  <refsynopsisdiv>
+    <synopsis><tag class="xmlpi">dbhh topicname="<replaceable>name</replaceable>" topicid="<replaceable>id</replaceable>"</tag></synopsis>
+  </refsynopsisdiv>
+  <refparameter>
+    <variablelist>
+      <varlistentry><term>topicname="<replaceable>name</replaceable>"</term>
+        <listitem>
+          <para>Specifies a unique string constant that identifies a help topic</para>
+        </listitem>
+      </varlistentry>
+      <varlistentry><term>topicid="<replaceable>id</replaceable>"</term>
+        <listitem>
+          <para>Specifies a unique integer value for the <literal>topicname</literal> string</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refparameter>
+  <refsee role="tcg">
+    <para><link role="tcg"
+        xlink:href="HtmlHelp.html#HHContextHelp"
+        >Context-sensitive help</link></para>
+  </refsee>
+</doc:pi>
+
+
 </xsl:stylesheet>