]> granicus.if.org Git - docbook-dsssl/commitdiff
Added documentation for the dbhh PI (used for context-sensitive HTML Help).
authorMauritz Jeanson <mj@johanneberg.com>
Thu, 9 Aug 2007 17:59:54 +0000 (17:59 +0000)
committerMauritz Jeanson <mj@johanneberg.com>
Thu, 9 Aug 2007 17:59:54 +0000 (17:59 +0000)
(The two templates matching 'dbhh' are still in htmlhelp-common.xsl).

xsl/html/pi.xsl

index 8e609bc09265db19e97a5b773e994756b07393c3..f7ffe6744a83753494c0aaf0956e349f4366793a 100644 (file)
   </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>