Merge pull request #126 from oreillymedia/schema

Updated specifications for subtitle handling

Author: Sanders Kleinfeld

htmlbook-xsl/chunk.xsl

@@ -26,9 +26,6 @@
   <!-- Nodeset of all chunks in this document -->
   <xsl:variable name="chunks" select="key('chunks', '1')"/> <!-- All chunks have an is-chunk() value of 1 -->
 
-  <!-- Specify a number from 0 to 5, where 0 means chunk at top-level sections (part, chapter, appendix), and 1-5 means chunk at the corresponding sect level (sect1 - sect5) -->
-  <xsl:param name="chunk.level" select="0"/>
-
   <!-- Specify whether to generate a root chunk -->
   <xsl:param name="generate.root.chunk" select="0"/>
 
@@ -77,7 +74,7 @@ sect5:s
   </xsl:template>
 
   <xsl:template match="h:section|h:div[contains(@data-type, 'part')]|h:nav[contains(@data-type, 'toc')]">
-    <xsl:variable name="is.chunk" select="htmlbook:is-chunk(., $chunk.level)"/>
+    <xsl:variable name="is.chunk" select="htmlbook:is-chunk(.)"/>
     <!-- <xsl:message>Element name: <xsl:value-of select="local-name()"/>, data-type name: <xsl:value-of select="@data-type"/>, Is chunk: <xsl:value-of select="$is.chunk"/></xsl:message> -->
     <xsl:choose>
       <xsl:when test="$is.chunk = 1">
@@ -139,7 +136,7 @@ sect5:s
 	  <!-- Root Chunk! Needs $outputdir in full file path-->
 	  <xsl:value-of select="concat($outputdir, $chars-to-append-to-outputdir)"/>
 	</xsl:when>
-	<xsl:when test="$outputdir != '' and not($generate.root.chunk = 1) and not($chunk[ancestor::*[htmlbook:is-chunk(., $chunk.level) = 1]])">
+	<xsl:when test="$outputdir != '' and not($generate.root.chunk = 1) and not($chunk[ancestor::*[htmlbook:is-chunk(.) = 1]])">
 	  <!-- $outputdir is specified and *is not* absolute filepath, 
 	       and generate.root.chunk is not specified (if it is, then previous "when" will set the outputdir properly),
 	       and chunk *is not* a nested chunk -->
@@ -287,7 +284,7 @@ sect5:s
 
       <!-- Check to see if parent is also chunk, in which case, call template recursively -->
       <xsl:variable name="parent-node" select="parent::*"/>
-      <xsl:variable name="parent-is-chunk" select="htmlbook:is-chunk($parent-node, $chunk.level)"/>
+      <xsl:variable name="parent-is-chunk" select="htmlbook:is-chunk($parent-node)"/>
       <xsl:if test="$parent-is-chunk = '1'">
 	<xsl:call-template name="output-filename-for-chunk">
 	  <xsl:with-param name="node" select="$parent-node"/>
@@ -534,7 +531,7 @@ sect5:s
   <xsl:template name="generate-footnotes">
 
     <!-- Only generate footnotes if the current node is a chunk -->
-    <xsl:if test="htmlbook:is-chunk(., $chunk.level)">
+    <xsl:if test="htmlbook:is-chunk(.)">
 
       <xsl:variable name="all-footnotes" select="//h:span[@data-type='footnote']"/>
 

htmlbook-xsl/common.xsl

@@ -343,13 +343,14 @@
   <!-- Logic for generating titles; default handling is to grab the first <h1>-<h6> content -->
   <xsl:template match="*" mode="title.markup">
     <xsl:choose>
-      <xsl:when test="self::h:section[@data-type='index' and not(h:h1|h:h2|h:h3|h:h4|h:h5|h:h6)]">
+      <xsl:when test="self::h:section[@data-type='index' and not(h:h1|h:h2|h:h3|h:h4|h:h5|h:h6|h:header/h:h1|h:header/h:h2|h:header/h:h3|h:header/h:h4|h:header/h:h5|h:header/h:h6)]">
 	<xsl:call-template name="get-localization-value">
 	  <xsl:with-param name="gentext-key" select="'index'"/>
 	</xsl:call-template>
       </xsl:when>
       <xsl:otherwise>
-	<xsl:apply-templates select="(h:h1|h:h2|h:h3|h:h4|h:h5|h:h6)[1]/node()"/>
+	<xsl:apply-templates select="(h:h1|h:h2|h:h3|h:h4|h:h5|h:h6|
+				      h:header/h:h1|h:header/h:h2|h:header/h:h3|h:header/h:h4|h:header/h:h5|h:header/h:h6)[1]/node()"/>
       </xsl:otherwise>
     </xsl:choose>
   </xsl:template>
@@ -358,9 +359,9 @@
   <xsl:template match="*" mode="process-heading">
     <xsl:param name="autogenerate.labels" select="$autogenerate.labels"/>
     <!-- Labeled element is typically the parent element of the heading (e.g., <section> or <figure>) -->
-    <xsl:param name="labeled-element" select=".."/>
+    <xsl:param name="labeled-element" select="(parent::h:header/parent::*|parent::*[not(self::h:header)])[1]"/>
     <!-- Labeled element semantic name is typically the parent element of the heading's @data-type -->
-    <xsl:param name="labeled-element-semantic-name" select="../@data-type"/>
+    <xsl:param name="labeled-element-semantic-name" select="(parent::h:header/parent::*|parent::*[not(self::h:header)])[1]/@data-type"/>
     <!-- Name for output heading element; same as current node name by default -->
     <xsl:param name="output-element-name" select="local-name(.)"/>
     <xsl:element name="{$output-element-name}" namespace="http://www.w3.org/1999/xhtml">
@@ -488,9 +489,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h1">
+      <xsl:when test="h:h1 or h:header/h:h1">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h1[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h1|h:header/h:h1)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>
@@ -506,9 +507,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h2">
+      <xsl:when test="h:h2 or h:header/h:h2">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h2[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h2|h:header/h:h2)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>
@@ -524,9 +525,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h3">
+      <xsl:when test="h:h3 or h:header/h:h3">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h3[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h3|h:header/h:h3)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>
@@ -542,9 +543,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h4">
+      <xsl:when test="h:h4 or h:header/h:h4">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h4[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h4|h:header/h:h4)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>
@@ -560,9 +561,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h5">
+      <xsl:when test="h:h5 or h:header/h:h5">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h5[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h5|h:header/h:h5)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>
@@ -578,9 +579,9 @@
       <xsl:when test="@data-pdf-bookmark">
 	<xsl:attribute name="data-pdf-bookmark" select="@data-pdf-bookmark"/>
       </xsl:when>
-      <xsl:when test="h:h1">
+      <xsl:when test="h:h1 or h:header/h:h1">
 	<xsl:variable name="processed-heading">
-	  <xsl:apply-templates select="h:h1[1]" mode="process-heading">
+	  <xsl:apply-templates select="(h:h1|h:header/h:h1)[1]" mode="process-heading">
 	    <xsl:with-param name="autogenerate.labels" select="$autogenerate.pdf.bookmark.labels"/>
 	  </xsl:apply-templates>
 	</xsl:variable>

htmlbook-xsl/elements.xsl

@@ -41,8 +41,13 @@
   </xsl:template>
 
   <xsl:template match="h:section[@data-type]/*[self::h:h1 or self::h:h2 or self::h:h3 or self::h:h4 or self::h:h5 or self::h:h6]|
-		       h:div[@data-type = 'part' or @data-type = 'example' or @data-type = 'equation']/*[self::h:h1 or self::h:h2 or self::h:h3 or self::h:h4 or self::h:h5 or self::h:h6]">
-    <xsl:apply-templates select="." mode="process-heading"/>
+		       h:section[@data-type]/h:header/*[self::h:h1 or self::h:h2 or self::h:h3 or self::h:h4 or self::h:h5 or self::h:h6]|
+		       h:div[@data-type = 'part' or @data-type = 'example' or @data-type = 'equation']/*[self::h:h1 or self::h:h2 or self::h:h3 or self::h:h4 or self::h:h5 or self::h:h6]|
+		       h:div[@data-type = 'part']/h:header/*[self::h:h1 or self::h:h2 or self::h:h3 or self::h:h4 or self::h:h5 or self::h:h6]">
+    <xsl:param name="autogenerate.labels" select="$autogenerate.labels"/>
+    <xsl:apply-templates select="." mode="process-heading">
+      <xsl:with-param name="autogenerate.labels" select="$autogenerate.labels"/>
+    </xsl:apply-templates>
   </xsl:template>
 
   <xsl:template match="h:figure">

htmlbook-xsl/epub.xsl

@@ -62,7 +62,7 @@
 
   <xsl:param name="metadata.title">
     <!-- Look for title first in head, then as child of body -->
-    <xsl:value-of select="(//h:head/h:title|//h:body/h:h1)[1]"/>
+    <xsl:value-of select="(//h:head/h:title|//h:body/h:h1|//h:body/h:header/h:h1)[1]"/>
   </xsl:param>
 
   <xsl:param name="metadata.language">

htmlbook-xsl/functions-exsl.xsl

@@ -11,7 +11,6 @@
 
   <func:function name="htmlbook:is-chunk">
     <xsl:param name="node"/>
-    <xsl:param name="chunk.level" select="$chunk.level"/>
     <xsl:choose>
       <xsl:when test="$node[self::h:div[contains(@data-type, 'part')]]">
 	<func:result>1</func:result>

htmlbook-xsl/functions-xslt2.xsl

@@ -10,7 +10,6 @@
 
   <xsl:function name="htmlbook:is-chunk">
     <xsl:param name="node"/>
-    <xsl:param name="chunk.level"/>
     <xsl:choose>
       <xsl:when test="$node[self::h:div[contains(@data-type, 'part')]]">1</xsl:when>
       <xsl:when test="$node[self::h:section[contains(@data-type, 'acknowledgments') or

htmlbook-xsl/ncx.xsl

@@ -59,7 +59,7 @@
 	      <navLabel>
 		<text>
 		  <!-- Look for title first in head, then as child of body -->
-		  <xsl:value-of select="(//h:head/h:title|//h:body/h:h1)[1]"/>
+		  <xsl:value-of select="(//h:head/h:title|//h:body/h:h1|//h:body/h:header/h:h1)[1]"/>
 		</text>
 	      </navLabel>
 	      <content src="{$root.chunk.filename}"/>

htmlbook-xsl/opf.xsl

@@ -604,7 +604,7 @@
     <xsl:for-each select="$element-descendants[1]">
       <xsl:choose>
 	<!-- Check if the element's nearest chunk ancestor is the chunk in question... -->
-	<xsl:when test="ancestor::*[htmlbook:is-chunk(., $chunk.level) = 1 and not(descendant::*[htmlbook:is-chunk(., $chunk.level) = 1][descendant::*[generate-id() = generate-id($element-descendants[1])]])][generate-id() = $chunk-id]">
+	<xsl:when test="ancestor::*[htmlbook:is-chunk(.) = 1 and not(descendant::*[htmlbook:is-chunk(.) = 1][descendant::*[generate-id() = generate-id($element-descendants[1])]])][generate-id() = $chunk-id]">
 	  <!--...It is: We have $element-name in this chunk! -->
 	  <xsl:text>1</xsl:text>
 	</xsl:when>

htmlbook-xsl/param.xsl

@@ -43,6 +43,9 @@
     </xsl:choose>
   </xsl:param>
 
+  <!-- For chunking templates: specify a number from 0 to 5, where 0 means chunk at top-level sections (part, chapter, appendix), and 1-5 means chunk at the corresponding sect level (sect1 - sect5) -->
+  <xsl:param name="chunk.level" select="0"/>
+
   <!-- Titling and labeling params -->
 
   <!-- Specify whether to autogenerate labels on sectioning and formal elements in HTML output (as opposed to labeling with CSS); default is to not include labels (0) -->

htmlbook-xsl/xspec/common.xspec

@@ -43,6 +43,19 @@ sect5:none
     <x:expect label="Copy the child content of the first h1-h6 as is">XPath <em>is</em> <strong>the bestest</strong></x:expect>
   </x:scenario>
 
+  <x:scenario label="When generating a title for a section that has heading info captured in a header element">
+    <x:context mode="title.markup">
+      <section data-type="chapter">
+	<header>
+	  <h1>Get this heading!</h1>
+	  <p data-type="subtitle">Ignore the second headling!</p>
+	</header>
+	<p>This is some boilerplate text</p>
+      </section>
+    </x:context>
+    <x:expect label="Copy the first h1 in the header element">Get this heading!</x:expect>
+  </x:scenario>
+
   <!-- Label markup tests -->
   <!-- This section's tests based on values in label.numeration.by.data-type global param -->
   <x:scenario label="When generating a label for a section (chapter)">