From f775f18d51e1556681a3d23be1b1716805ed301d Mon Sep 17 00:00:00 2001
From: Jirka Kosek <jirka@kosek.cz>
Date: Sat, 9 Feb 2002 22:05:21 +0000
Subject: [PATCH] Added parameter which controls appearance of root element in
 HTML Help ToC.

---
 xsl/html/Makefile.param               |   3 +
 xsl/html/param.ent                    |   1 +
 xsl/html/param.xweb                   |   2 +
 xsl/htmlhelp/htmlhelp.xsl             | 169 +++++++++++++++-----------
 xsl/params/htmlhelp.hhc.show.root.xml |  24 ++++
 5 files changed, 126 insertions(+), 73 deletions(-)
 create mode 100644 xsl/params/htmlhelp.hhc.show.root.xml

diff --git a/xsl/html/Makefile.param b/xsl/html/Makefile.param
index 89daca59a..a55bbfbfd 100644
--- a/xsl/html/Makefile.param
+++ b/xsl/html/Makefile.param
@@ -24,6 +24,7 @@ PARAMS=../params/admon.graphics.xml \
        ../params/chunk.datafile.xml \
        ../params/chunk.first.sections.xml \
        ../params/chunk.section.depth.xml \
+       ../params/chunk.toc.xml \
        ../params/citerefentry.link.xml \
        ../params/css.decoration.xml \
        ../params/default.encoding.xml \
@@ -72,6 +73,7 @@ PARAMS=../params/admon.graphics.xml \
        ../params/htmlhelp.hhc.xml \
        ../params/htmlhelp.hhc.folders.instead.books.xml \
        ../params/htmlhelp.hhc.section.depth.xml \
+       ../params/htmlhelp.hhc.show.root.xml \
        ../params/htmlhelp.hhp.xml \
        ../params/htmlhelp.hhp.tail.xml \
        ../params/htmlhelp.map.file.xml \
@@ -86,6 +88,7 @@ PARAMS=../params/admon.graphics.xml \
        ../params/make.valid.html.xml \
        ../params/make.single.year.ranges.xml \
        ../params/make.year.ranges.xml \
+       ../params/manual.toc.xml \
        ../params/navig.graphics.xml \
        ../params/navig.graphics.extension.xml \
        ../params/navig.graphics.path.xml \
diff --git a/xsl/html/param.ent b/xsl/html/param.ent
index a3592a2c3..ddef8bcd6 100644
--- a/xsl/html/param.ent
+++ b/xsl/html/param.ent
@@ -73,6 +73,7 @@
 <!ENTITY htmlhelp.hhc SYSTEM "../params/htmlhelp.hhc.xml">
 <!ENTITY htmlhelp.hhc.folders.instead.books SYSTEM "../params/htmlhelp.hhc.folders.instead.books.xml">
 <!ENTITY htmlhelp.hhc.section.depth SYSTEM "../params/htmlhelp.hhc.section.depth.xml">
+<!ENTITY htmlhelp.hhc.show.root SYSTEM "../params/htmlhelp.hhc.show.root.xml">
 <!ENTITY htmlhelp.hhp SYSTEM "../params/htmlhelp.hhp.xml">
 <!ENTITY htmlhelp.hhp.tail SYSTEM "../params/htmlhelp.hhp.tail.xml">
 <!ENTITY htmlhelp.map.file SYSTEM "../params/htmlhelp.map.file.xml">
diff --git a/xsl/html/param.xweb b/xsl/html/param.xweb
index d18a09435..4f8c77ea1 100644
--- a/xsl/html/param.xweb
+++ b/xsl/html/param.xweb
@@ -260,6 +260,7 @@ to be incomplete. Don't forget to read the source, too :-)</para>
 &htmlhelp.map.file;
 &htmlhelp.alias.file;
 &htmlhelp.hhc.section.depth;
+&htmlhelp.hhc.show.root;
 &htmlhelp.hhc.folders.instead.books;
 &htmlhelp.title;
 </reference>
@@ -362,6 +363,7 @@ around all these parameters.</para>
 <src:fragref linkend="htmlhelp.hhc.frag"/>
 <src:fragref linkend="htmlhelp.hhc.folders.instead.books.frag"/>
 <src:fragref linkend="htmlhelp.hhc.section.depth.frag"/>
+<src:fragref linkend="htmlhelp.hhc.show.root.frag"/>
 <src:fragref linkend="htmlhelp.hhp.frag"/>
 <src:fragref linkend="htmlhelp.hhp.tail.frag"/>
 <src:fragref linkend="htmlhelp.map.file.frag"/>
diff --git a/xsl/htmlhelp/htmlhelp.xsl b/xsl/htmlhelp/htmlhelp.xsl
index 462c3018a..ef059fdcd 100644
--- a/xsl/htmlhelp/htmlhelp.xsl
+++ b/xsl/htmlhelp/htmlhelp.xsl
@@ -349,8 +349,10 @@ Title=</xsl:text>
 &lt;/OBJECT&gt;
 </xsl:text>
   </xsl:if>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0">
 <xsl:text>&lt;UL&gt;
 </xsl:text>
+  </xsl:if>
 
   <xsl:choose>
     <xsl:when test="$rootid != ''">
@@ -361,8 +363,11 @@ Title=</xsl:text>
     </xsl:otherwise>
   </xsl:choose>
 
+  <xsl:if test="$htmlhelp.hhc.show.root != 0">
   <xsl:text>&lt;/UL&gt;
-&lt;/BODY&gt;
+</xsl:text>
+  </xsl:if>
+  <xsl:text>&lt;/BODY&gt;
 &lt;/HTML&gt;</xsl:text>
 </xsl:template>
 
@@ -379,14 +384,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="book">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="book" mode="hhc"/>
@@ -407,14 +414,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="part|reference|preface|chapter|appendix|bibliography|article|colophon">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="part|reference|preface|chapter|bibliography|appendix|article|colophon"
@@ -437,14 +446,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="reference|preface|chapter|appendix|refentry|section|sect1|bibliodiv">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates
@@ -467,14 +478,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="section[count(ancestor::section) &lt; $htmlhelp.hhc.section.depth]">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="section" mode="hhc"/>
@@ -495,14 +508,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="sect2[$htmlhelp.hhc.section.depth > 1]">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="sect2"
@@ -524,14 +539,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="sect3[$htmlhelp.hhc.section.depth > 2]">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="sect3"
@@ -553,14 +570,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="sect4[$htmlhelp.hhc.section.depth > 3]">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="sect4"
@@ -582,14 +601,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
   <xsl:if test="sect5[$htmlhelp.hhc.section.depth > 4]">
     <xsl:text>&lt;UL&gt;</xsl:text>
       <xsl:apply-templates select="sect5"
@@ -611,14 +632,16 @@ Title=</xsl:text>
     <xsl:apply-templates select="." mode="title.markup"/>
   </xsl:variable>
 
-  <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
-    &lt;param name="Name" value="</xsl:text>
-	<xsl:value-of select="normalize-space($title)"/>
-    <xsl:text>"&gt;
-    &lt;param name="Local" value="</xsl:text>
-	<xsl:call-template name="href.target.with.base.dir"/>
-    <xsl:text>"&gt;
-  &lt;/OBJECT&gt;</xsl:text>
+  <xsl:if test="$htmlhelp.hhc.show.root != 0 or parent::*">
+    <xsl:text>&lt;LI&gt; &lt;OBJECT type="text/sitemap"&gt;
+      &lt;param name="Name" value="</xsl:text>
+          <xsl:value-of select="normalize-space($title)"/>
+      <xsl:text>"&gt;
+      &lt;param name="Local" value="</xsl:text>
+          <xsl:call-template name="href.target.with.base.dir"/>
+      <xsl:text>"&gt;
+    &lt;/OBJECT&gt;</xsl:text>
+  </xsl:if>
 </xsl:template>
 
 <!-- ==================================================================== -->
diff --git a/xsl/params/htmlhelp.hhc.show.root.xml b/xsl/params/htmlhelp.hhc.show.root.xml
new file mode 100644
index 000000000..3d4a5b424
--- /dev/null
+++ b/xsl/params/htmlhelp.hhc.show.root.xml
@@ -0,0 +1,24 @@
+<refentry id="htmlhelp.hhc.show.root">
+<refmeta>
+<refentrytitle>htmlhelp.hhc.show.root</refentrytitle>
+<refmiscinfo role="type">boolean</refmiscinfo>
+</refmeta>
+<refnamediv>
+<refname>htmlhelp.hhc.show.root</refname>
+<refpurpose>Should be entry for root element shown in ToC?</refpurpose>
+</refnamediv>
+
+<refsynopsisdiv>
+<src:fragment id='htmlhelp.hhc.show.root.frag'>
+<xsl:param name="htmlhelp.hhc.show.root" select="1"/>
+</src:fragment>
+</refsynopsisdiv>
+
+<refsect1><title>Description</title>
+
+<para>If set to 0, there will be no entry for root element in
+ToC. This is useful when you want provide user with expanded ToC as
+a default.</para>
+
+</refsect1>
+</refentry>
-- 
2.40.0