Added parameter ncx.toc.section.depth to enable configuration of the depth of the NCX TOC.

Author: Sanders Kleinfeld

htmlbook-xsl/epub.xsl

@@ -167,6 +167,13 @@
   <!-- ID to use in the manifest for the NCX TOC (if $generate.ncx.toc is enabled) -->
   <xsl:param name="ncx.toc.id">toc.ncx</xsl:param>
 
+  <!-- Specify how many levels of sections to include in NCX TOC. 
+       An $ncx.toc.section.depth of 0 indicates only chapter-level headings and above to be included in NCX TOC
+       An $ncx.toc.section depth of 1 indicates only sect1-level headings and above to be included in NCX TOC
+       And so on...
+    -->
+  <xsl:param name="ncx.toc.section.depth" select="4"/>
+
   <!-- Include labels in NCX TOC? -->
   <xsl:param name="ncx.toc.include.labels" select="1"/>
 

htmlbook-xsl/ncx.xsl

@@ -78,7 +78,9 @@
   </xsl:template>
 
   <xsl:template match="h:section[not(@data-type = 'dedication' or @data-type = 'titlepage' or @data-type = 'toc' or @data-type = 'colophon' or @data-type = 'copyright-page' or @data-type = 'halftitlepage')]|h:div[@data-type='part']" mode="ncx.toc.gen">
-    <xsl:call-template name="generate.navpoint"/>
+    <xsl:if test="not(self::h:section[contains(@data-type, 'sect') and htmlbook:section-depth(.) != '' and htmlbook:section-depth(.) &gt; $ncx.toc.section.depth])">
+      <xsl:call-template name="generate.navpoint"/>
+    </xsl:if>
   </xsl:template>
 
   <!-- Only put the Nav doc in the NCX TOC if $nav.in.ncx is enabled -->

htmlbook-xsl/xspec/ncx.xspec

@@ -27,6 +27,8 @@ sect4:none
 sect5:none
   </x:param>
 
+  <x:param name="ncx.toc.section.depth" select="2"/>
+
   <x:scenario label="When generating full NCX TOC content">
     <x:call template="generate.ncx.toc.content">
       <!-- Test XSL is output to a subdir of the .xspec dir, which also contains skeleton, so relative path contains .. to go up a directory level -->
@@ -81,8 +83,10 @@ sect5:none
         <ncx:navPoint id="...">...</ncx:navPoint>
       </x:expect>
 
+      <!-- Note: the following test is dependent on the global param set in this xspec document -->
+      <!-- If test fails, double-check expected value is in sync with these params -->
       <x:scenario label="when source TOC elements are at a lower level than specified NCX Level">
-	<x:context mode="ncx.toc.gen" select="//h:section[@data-type='sect2'][1]">
+	<x:context mode="ncx.toc.gen" select="//h:section[@data-type='sect3'][1]">
 	  <section data-type="chapter">
 	    <h1>Test Chapter</h1>
 	    <p>It was the worst of times!</p>
@@ -92,6 +96,10 @@ sect5:none
 	      <section data-type="sect2">
 		<h2>Test Sect2</h2>
 		<p>One fish, two fish, red fish, blue fish</p>
+		<section data-type="sect3">
+		  <h3>Test SEct3</h3>
+		  <p>It was a dark and stormy night</p>
+		</section>
 	      </section>
 	    </section>
 	  </section>
@@ -151,7 +159,7 @@ sect5:none
 	<x:call>
 	  <x:param name="ncx.toc.include.labels" select="1"/>
 	</x:call>
-	<!-- Note: the following value is dependent on the global param set in this xspec document -->
+	<!-- Note: the following value is dependent on the global params set in this xspec document -->
 	<!-- If test fails, double-check expected value is in sync with these params -->
 	<x:expect label="A navLabel's text content should include labels"
 		  test="count(ncx:navPoint/ncx:navLabel[contains(., 'A. ')]) = 1"/>