From: Jirka Kosek <jirka@kosek.cz>
Date: Sun, 10 Feb 2002 10:21:22 +0000 (+0000)
Subject: Added parameter htmlhelp.default.topic for overriding default topic to display.
X-Git-Tag: release/1.79.1~6^2~5928
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=e53b33537bbbae72f16426a30f23af919890f126;p=docbook-dsssl

Added parameter htmlhelp.default.topic for overriding default topic to display.
---

diff --git a/xsl/html/Makefile.param b/xsl/html/Makefile.param
index a55bbfbfd..c515edb03 100644
--- a/xsl/html/Makefile.param
+++ b/xsl/html/Makefile.param
@@ -67,6 +67,7 @@ PARAMS=../params/admon.graphics.xml \
        ../params/htmlhelp.alias.file.xml \
        ../params/htmlhelp.autolabel.xml \
        ../params/htmlhelp.chm.xml \
+       ../params/htmlhelp.default.topic.xml \
        ../params/htmlhelp.encoding.xml \
        ../params/htmlhelp.enumerate.images.xml \
        ../params/htmlhelp.force.map.and.alias.xml \
diff --git a/xsl/html/param.ent b/xsl/html/param.ent
index ddef8bcd6..4d4452a02 100644
--- a/xsl/html/param.ent
+++ b/xsl/html/param.ent
@@ -67,6 +67,7 @@
 <!ENTITY htmlhelp.alias.file SYSTEM "../params/htmlhelp.alias.file.xml">
 <!ENTITY htmlhelp.autolabel SYSTEM "../params/htmlhelp.autolabel.xml">
 <!ENTITY htmlhelp.chm SYSTEM "../params/htmlhelp.chm.xml">
+<!ENTITY htmlhelp.default.topic SYSTEM "../params/htmlhelp.default.topic.xml">
 <!ENTITY htmlhelp.encoding SYSTEM "../params/htmlhelp.encoding.xml">
 <!ENTITY htmlhelp.enumerate.images SYSTEM "../params/htmlhelp.enumerate.images.xml">
 <!ENTITY htmlhelp.force.map.and.alias SYSTEM "../params/htmlhelp.force.map.and.alias.xml">
diff --git a/xsl/html/param.xweb b/xsl/html/param.xweb
index 4f8c77ea1..44e78349f 100644
--- a/xsl/html/param.xweb
+++ b/xsl/html/param.xweb
@@ -252,6 +252,7 @@ to be incomplete. Don't forget to read the source, too :-)</para>
 &htmlhelp.encoding;
 &htmlhelp.autolabel;
 &htmlhelp.chm;
+&htmlhelp.default.topic;
 &htmlhelp.hhp;
 &htmlhelp.hhc;
 &htmlhelp.hhp.tail;
@@ -357,6 +358,7 @@ around all these parameters.</para>
 <src:fragref linkend="htmlhelp.alias.file.frag"/>
 <src:fragref linkend="htmlhelp.autolabel.frag"/>
 <src:fragref linkend="htmlhelp.chm.frag"/>
+<src:fragref linkend="htmlhelp.default.topic.frag"/>
 <src:fragref linkend="htmlhelp.encoding.frag"/>
 <src:fragref linkend="htmlhelp.enumerate.images.frag"/>
 <src:fragref linkend="htmlhelp.force.map.and.alias.frag"/>
diff --git a/xsl/htmlhelp/htmlhelp.xsl b/xsl/htmlhelp/htmlhelp.xsl
index d9b64adbf..7c3599788 100644
--- a/xsl/htmlhelp/htmlhelp.xsl
+++ b/xsl/htmlhelp/htmlhelp.xsl
@@ -80,19 +80,26 @@
 Compiled file=</xsl:text><xsl:value-of select="$htmlhelp.chm"/><xsl:text>
 Contents file=</xsl:text><xsl:value-of select="$htmlhelp.hhc"/><xsl:text>
 Default topic=</xsl:text>
- <xsl:call-template name="make-relative-filename">
-   <xsl:with-param name="base.dir" select="$base.dir"/>
-   <xsl:with-param name="base.name">
-     <xsl:choose>
-       <xsl:when test="$rootid != ''">
-         <xsl:apply-templates select="key('id',$rootid)" mode="chunk-filename"/>
-       </xsl:when>
-       <xsl:otherwise>
-         <xsl:apply-templates select="/" mode="chunk-filename"/>
-       </xsl:otherwise>
-     </xsl:choose>
-   </xsl:with-param>
- </xsl:call-template>
+<xsl:choose>
+  <xsl:when test="$htmlhelp.default.topic != ''">
+    <xsl:value-of select="$htmlhelp.default.topic"/>
+  </xsl:when>
+  <xsl:otherwise>
+    <xsl:call-template name="make-relative-filename">
+      <xsl:with-param name="base.dir" select="$base.dir"/>
+      <xsl:with-param name="base.name">
+        <xsl:choose>
+          <xsl:when test="$rootid != ''">
+            <xsl:apply-templates select="key('id',$rootid)" mode="chunk-filename"/>
+          </xsl:when>
+          <xsl:otherwise>
+            <xsl:apply-templates select="/" mode="chunk-filename"/>
+          </xsl:otherwise>
+        </xsl:choose>
+      </xsl:with-param>
+    </xsl:call-template>
+  </xsl:otherwise>
+</xsl:choose>
 <xsl:text>
 Display compile progress=No
 Full-text search=Yes
diff --git a/xsl/params/htmlhelp.default.topic.xml b/xsl/params/htmlhelp.default.topic.xml
new file mode 100644
index 000000000..9350d7b3a
--- /dev/null
+++ b/xsl/params/htmlhelp.default.topic.xml
@@ -0,0 +1,31 @@
+<refentry id="htmlhelp.default.topic">
+<refmeta>
+<refentrytitle>htmlhelp.default.topic</refentrytitle>
+<refmiscinfo role="type">string</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>htmlhelp.default.topic</refname>
+<refpurpose>Name of file with default topic</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='htmlhelp.default.topic.frag'>
+<xsl:param name="htmlhelp.default.topic" select="''"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>Normally first chunk of document is displayed when you open HTML
+Help file. If you want to display another topic, simply set its
+filename by this parameter.</para>
+
+<para>This is useful especially if you don't generate ToC in front of
+your document and you also hide root element in ToC. E.g.:</para>
+
+<programlisting><![CDATA[<xsl:param name="generate.book.toc" select="0"/>
+<xsl:param name="htmlhelp.hhc.show.root" select="0"/>
+<xsl:param name="htmlhelp.default.topic" select="'pr01.html'"/>]]></programlisting>
+
+</refsect1>
+</refentry>