From 58c0482a192f2d7e83e1f09b09e00dd6e3d3b6cd Mon Sep 17 00:00:00 2001
From: Bob Stayton <bobs@sagehill.net>
Date: Thu, 12 Mar 2009 22:33:55 +0000
Subject: [PATCH] Rewrite toc templates to support an empty toc or populated
 toc in all permitted contexts.  Same for lot elements. This fixes bug
 #1595969 for HTML outputs.

---
 xsl/html/toc.xsl | 297 ++++++++++++++++++++++++++++++++++++++---------
 1 file changed, 239 insertions(+), 58 deletions(-)

diff --git a/xsl/html/toc.xsl b/xsl/html/toc.xsl
index 3cd483d17..bffd2a03e 100644
--- a/xsl/html/toc.xsl
+++ b/xsl/html/toc.xsl
@@ -14,53 +14,144 @@
 
 <!-- ==================================================================== -->
 
-<xsl:template match="toc">
-  <xsl:choose>
-    <xsl:when test="*">
-      <xsl:if test="$process.source.toc != 0">
-        <!-- if the toc isn't empty, process it -->
-        <xsl:element name="{$toc.list.type}">
-          <xsl:apply-templates/>
-        </xsl:element>
-      </xsl:if>
-    </xsl:when>
-    <xsl:otherwise>
-      <xsl:if test="$process.empty.source.toc != 0">
-        <xsl:choose>
-          <xsl:when test="parent::section
-                          or parent::sect1
-                          or parent::sect2
-                          or parent::sect3
-                          or parent::sect4
-                          or parent::sect5">
-            <xsl:apply-templates select="parent::*"
-                                 mode="toc.for.section"/>
-          </xsl:when>
-          <xsl:when test="parent::article">
-            <xsl:apply-templates select="parent::*"
-                                 mode="toc.for.component"/>
-          </xsl:when>
-          <xsl:when test="parent::book
-                          or parent::part">
-            <xsl:apply-templates select="parent::*"
-                                 mode="toc.for.division"/>
-          </xsl:when>
-          <xsl:when test="parent::set">
-            <xsl:apply-templates select="parent::*"
-                                 mode="toc.for.set"/>
-          </xsl:when>
-          <!-- there aren't any other contexts that allow toc -->
-          <xsl:otherwise>
-            <xsl:message>
-              <xsl:text>I don't know how to make a TOC in this context!</xsl:text>
-            </xsl:message>
-          </xsl:otherwise>
-        </xsl:choose>
-      </xsl:if>
-    </xsl:otherwise>
-  </xsl:choose>
+<xsl:template match="set/toc | book/toc | part/toc">
+  <xsl:variable name="toc.params">
+    <xsl:call-template name="find.path.params">
+      <xsl:with-param name="node" select="parent::*"/>
+      <xsl:with-param name="table" select="normalize-space($generate.toc)"/>
+    </xsl:call-template>
+  </xsl:variable>
+
+  <!-- Do not output the toc element if one is already generated
+       by the use of $generate.toc parameter, or if
+       generating a source toc is turned off -->
+  <xsl:if test="not(contains($toc.params, 'toc')) and
+                ($process.source.toc != 0 or $process.empty.source.toc != 0)">
+    <xsl:variable name="content">
+      <xsl:choose>
+        <xsl:when test="* and $process.source.toc != 0">
+          <xsl:apply-templates />
+        </xsl:when>
+        <xsl:when test="count(*) = 0 and $process.empty.source.toc != 0">
+          <!-- trick to switch context node to parent element -->
+          <xsl:for-each select="parent::*">
+            <xsl:choose>
+              <xsl:when test="self::set">
+                <xsl:call-template name="set.toc">
+                  <xsl:with-param name="toc.title.p" 
+                                  select="contains($toc.params, 'title')"/>
+                </xsl:call-template>
+              </xsl:when>
+              <xsl:when test="self::book">
+                <xsl:call-template name="division.toc">
+                  <xsl:with-param name="toc.title.p" 
+                                  select="contains($toc.params, 'title')"/>
+                </xsl:call-template>
+              </xsl:when>
+              <xsl:when test="self::part">
+                <xsl:call-template name="division.toc">
+                  <xsl:with-param name="toc.title.p" 
+                                  select="contains($toc.params, 'title')"/>
+                </xsl:call-template>
+              </xsl:when>
+            </xsl:choose>
+          </xsl:for-each>
+        </xsl:when>
+      </xsl:choose>
+    </xsl:variable>
+
+    <xsl:if test="string-length(normalize-space($content)) != 0">
+      <xsl:copy-of select="$content"/>
+    </xsl:if>
+  </xsl:if>
+</xsl:template>
+  
+<xsl:template match="chapter/toc | appendix/toc | preface/toc | article/toc">
+  <xsl:variable name="toc.params">
+    <xsl:call-template name="find.path.params">
+      <xsl:with-param name="node" select="parent::*"/>
+      <xsl:with-param name="table" select="normalize-space($generate.toc)"/>
+    </xsl:call-template>
+  </xsl:variable>
+
+  <!-- Do not output the toc element if one is already generated
+       by the use of $generate.toc parameter, or if
+       generating a source toc is turned off -->
+  <xsl:if test="not(contains($toc.params, 'toc')) and
+                ($process.source.toc != 0 or $process.empty.source.toc != 0)">
+    <xsl:choose>
+      <xsl:when test="* and $process.source.toc != 0">
+        <div>
+          <xsl:apply-templates select="." mode="class.attribute"/>
+          <xsl:apply-templates select="title"/> 
+          <dl>
+            <xsl:apply-templates select="." mode="class.attribute"/>
+            <xsl:apply-templates select="*[not(self::title)]"/> 
+          </dl>
+        </div>
+        <xsl:call-template name="component.toc.separator"/>
+      </xsl:when>
+      <xsl:when test="count(*) = 0 and $process.empty.source.toc != 0">
+        <!-- trick to switch context node to section element -->
+        <xsl:for-each select="parent::*">
+          <xsl:call-template name="component.toc">
+            <xsl:with-param name="toc.title.p" 
+                            select="contains($toc.params, 'title')"/>
+          </xsl:call-template>
+        </xsl:for-each>
+        <xsl:call-template name="component.toc.separator"/>
+      </xsl:when>
+    </xsl:choose>
+  </xsl:if>
+</xsl:template>
+
+<xsl:template match="section/toc
+                    |sect1/toc
+                    |sect2/toc
+                    |sect3/toc
+                    |sect4/toc
+                    |sect5/toc">
+
+  <xsl:variable name="toc.params">
+    <xsl:call-template name="find.path.params">
+      <xsl:with-param name="node" select="parent::*"/>
+      <xsl:with-param name="table" select="normalize-space($generate.toc)"/>
+    </xsl:call-template>
+  </xsl:variable>
+
+  <!-- Do not output the toc element if one is already generated
+       by the use of $generate.toc parameter, or if
+       generating a source toc is turned off -->
+  <xsl:if test="not(contains($toc.params, 'toc')) and
+                ($process.source.toc != 0 or $process.empty.source.toc != 0)">
+    <xsl:choose>
+      <xsl:when test="* and $process.source.toc != 0">
+        <div>
+          <xsl:apply-templates select="." mode="class.attribute"/>
+          <xsl:apply-templates select="title"/> 
+          <dl>
+            <xsl:apply-templates select="." mode="class.attribute"/>
+            <xsl:apply-templates select="*[not(self::title)]"/> 
+          </dl>
+        </div>
+        <xsl:call-template name="section.toc.separator"/>
+      </xsl:when>
+      <xsl:when test="count(*) = 0 and $process.empty.source.toc != 0">
+        <!-- trick to switch context node to section element -->
+        <xsl:for-each select="parent::*">
+          <xsl:call-template name="section.toc">
+            <xsl:with-param name="toc.title.p" 
+                            select="contains($toc.params, 'title')"/>
+          </xsl:call-template>
+        </xsl:for-each>
+        <xsl:call-template name="section.toc.separator"/>
+      </xsl:when>
+    </xsl:choose>
+  </xsl:if>
 </xsl:template>
 
+<!-- ==================================================================== -->
+
 <xsl:template match="tocpart|tocchap
                      |toclevel1|toclevel2|toclevel3|toclevel4|toclevel5">
   <xsl:variable name="sub-toc">
@@ -68,14 +159,19 @@
       <xsl:choose>
         <xsl:when test="$toc.list.type = 'dl'">
           <dd>
+            <xsl:apply-templates select="." mode="class.attribute"/>
             <xsl:element name="{$toc.list.type}">
-              <xsl:apply-templates select="tocchap|toclevel1|toclevel2|toclevel3|toclevel4|toclevel5"/>
+              <xsl:apply-templates select="." mode="class.attribute"/>
+              <xsl:apply-templates select="tocchap|toclevel1|toclevel2|
+                                           toclevel3|toclevel4|toclevel5"/>
             </xsl:element>
           </dd>
         </xsl:when>
         <xsl:otherwise>
           <xsl:element name="{$toc.list.type}">
-            <xsl:apply-templates select="tocchap|toclevel1|toclevel2|toclevel3|toclevel4|toclevel5"/>
+            <xsl:apply-templates select="." mode="class.attribute"/>
+            <xsl:apply-templates select="tocchap|toclevel1|toclevel2|
+                                         toclevel3|toclevel4|toclevel5"/>
           </xsl:element>
         </xsl:otherwise>
       </xsl:choose>
@@ -87,12 +183,14 @@
   <xsl:choose>
     <xsl:when test="$toc.list.type = 'dl'">
       <dt>
+        <xsl:apply-templates select="." mode="class.attribute"/>
         <xsl:apply-templates select="tocentry[position() = last()]"/>
       </dt>
       <xsl:copy-of select="$sub-toc"/>
     </xsl:when>
     <xsl:otherwise>
       <li>
+        <xsl:apply-templates select="." mode="class.attribute"/>
         <xsl:apply-templates select="tocentry[position() = last()]"/>
         <xsl:copy-of select="$sub-toc"/>
       </li>
@@ -100,15 +198,17 @@
   </xsl:choose>
 </xsl:template>
 
-<xsl:template match="tocentry|tocfront|tocback">
+<xsl:template match="tocentry|tocdiv|lotentry|tocfront|tocback">
   <xsl:choose>
     <xsl:when test="$toc.list.type = 'dl'">
       <dt>
+        <xsl:apply-templates select="." mode="class.attribute"/>
         <xsl:call-template name="tocentry-content"/>
       </dt>
     </xsl:when>
     <xsl:otherwise>
       <li>
+        <xsl:apply-templates select="." mode="class.attribute"/>
         <xsl:call-template name="tocentry-content"/>
       </li>
     </xsl:otherwise>
@@ -143,27 +243,108 @@
   </xsl:choose>
 </xsl:template>
 
+<xsl:template match="toc/title">
+  <div>
+    <xsl:apply-templates select="." mode="class.attribute"/>
+    <xsl:apply-templates/>
+  </div>
+</xsl:template>
+
+<xsl:template match="toc/subtitle">
+  <div>
+    <xsl:apply-templates select="." mode="class.attribute"/>
+    <xsl:apply-templates/>
+  </div>
+</xsl:template>
+
+<xsl:template match="toc/titleabbrev">
+</xsl:template>
+
 <!-- ==================================================================== -->
 
-<xsl:template match="*" mode="toc.for.section">
-  <xsl:call-template name="section.toc"/>
+<!-- A lot element must have content, because there is no attribute
+     to select what kind of list should be generated -->
+<xsl:template match="book/lot | part/lot">
+  <!-- Don't generate a page sequence unless there is content -->
+  <xsl:variable name="content">
+    <xsl:choose>
+      <xsl:when test="* and $process.source.toc != 0">
+        <div>
+          <xsl:apply-templates select="." mode="class.attribute"/>
+          <xsl:apply-templates />
+        </div>
+      </xsl:when>
+      <xsl:when test="not(child::*) and $process.empty.source.toc != 0">
+        <xsl:call-template name="process.empty.lot"/>
+      </xsl:when>
+    </xsl:choose>
+  </xsl:variable>
+
+  <xsl:if test="string-length(normalize-space($content)) != 0">
+    <xsl:copy-of select="$content"/>
+  </xsl:if>
+</xsl:template>
+  
+<xsl:template match="chapter/lot | appendix/lot | preface/lot | article/lot">
+  <xsl:choose>
+    <xsl:when test="* and $process.source.toc != 0">
+      <div>
+        <xsl:apply-templates select="." mode="class.attribute"/>
+        <xsl:apply-templates />
+      </div>
+      <xsl:call-template name="component.toc.separator"/>
+    </xsl:when>
+    <xsl:when test="not(child::*) and $process.empty.source.toc != 0">
+      <xsl:call-template name="process.empty.lot"/>
+    </xsl:when>
+  </xsl:choose>
 </xsl:template>
 
-<xsl:template match="*" mode="toc.for.component">
-  <xsl:call-template name="component.toc"/>
+<xsl:template match="section/lot
+                    |sect1/lot
+                    |sect2/lot
+                    |sect3/lot
+                    |sect4/lot
+                    |sect5/lot">
+  <xsl:choose>
+    <xsl:when test="* and $process.source.toc != 0">
+      <div>
+        <xsl:apply-templates select="." mode="class.attribute"/>
+        <xsl:apply-templates/>
+      </div>
+      <xsl:call-template name="section.toc.separator"/>
+    </xsl:when>
+    <xsl:when test="not(child::*) and $process.empty.source.toc != 0">
+      <xsl:call-template name="process.empty.lot"/>
+    </xsl:when>
+  </xsl:choose>
 </xsl:template>
 
-<xsl:template match="*" mode="toc.for.division">
-  <xsl:call-template name="division.toc"/>
+<xsl:template name="process.empty.lot">
+  <!-- An empty lot element does not provide any information to indicate
+       what should be included in it.  You can customize this
+       template to generate a lot based on @role or something -->
+  <xsl:message>
+    <xsl:text>Warning: don't know what to generate for </xsl:text>
+    <xsl:text>lot that has no children.</xsl:text>
+  </xsl:message>
 </xsl:template>
 
-<xsl:template match="*" mode="toc.for.set">
-  <xsl:call-template name="set.toc"/>
+<xsl:template match="lot/title">
+  <div>
+    <xsl:apply-templates select="." mode="class.attribute"/>
+    <xsl:apply-templates/>
+  </div>
 </xsl:template>
 
-<!-- ==================================================================== -->
+<xsl:template match="lot/subtitle">
+  <div>
+    <xsl:apply-templates select="." mode="class.attribute"/>
+    <xsl:apply-templates/>
+  </div>
+</xsl:template>
 
-<xsl:template match="lot|lotentry">
+<xsl:template match="lot/titleabbrev">
 </xsl:template>
 
 </xsl:stylesheet>
-- 
2.50.1