Adding xref handling for equations and the corresponding tests in the test suite

Author: Chris Pappas

htmlbook-xsl/xrefgen.xsl

@@ -245,6 +245,42 @@
       </xsl:otherwise>
     </xsl:choose>
   </xsl:template>
+  
+  <!-- ADDING HANDLING FOR XREFS TO EQUATION -->
+  <!-- Adapted from docbook-xsl templates in xhtml/xref.xsl -->
+  <xsl:template match="h:div[@data-type='equation']" mode="xref-to">
+    <xsl:param name="referrer"/>
+    <xsl:param name="xrefstyle"/>
+    <xsl:param name="verbose" select="1"/>
+    
+    <xsl:choose>
+      <xsl:when test="h:h5">
+        <xsl:apply-templates select="." mode="object.xref.markup">
+          <xsl:with-param name="purpose" select="'xref'"/>
+          <!-- BEGIN OVERRIDE -->
+          <xsl:with-param name="xrefstyle" select="'template:Equation %n'"/>
+          <!-- END OVERRIDE -->
+          <xsl:with-param name="referrer" select="$referrer"/>
+          <xsl:with-param name="verbose" select="$verbose"/>
+        </xsl:apply-templates>
+      </xsl:when>
+      <xsl:otherwise>
+        <!-- Otherwise, throw warning, and print out ??? -->
+        <xsl:call-template name="log-message">
+          <xsl:with-param name="type" select="'WARNING'"/>
+          <xsl:with-param name="message">
+            <xsl:text>Cannot output gentext for XREF to refsection (id:</xsl:text>
+            <xsl:value-of select="@id"/>
+            <xsl:text>) that does not contain a descendant h6 element</xsl:text>
+          </xsl:with-param>
+        </xsl:call-template>
+        <xsl:text>???</xsl:text>
+      </xsl:otherwise>
+
+    </xsl:choose>
+
+  </xsl:template>
+  
 
   <!-- Adapted from docbook-xsl templates in common/gentext.xsl -->
   <!-- For simplicity, not folding in all the special 'select: ' logic (some of which is FO-specific, anyway) -->

htmlbook-xsl/xspec/xrefgen.xspec

@@ -265,6 +265,80 @@ toc:lower-roman
   </x:scenario>
   <!--End Chris's refsect work -->
 
+  <!-- Begin Chris's Equation Work select="(//h:a[@data-type='xref'])[1]" -->
+  <x:scenario label="When an XREF points to a formal equation with a caption">
+    <x:context mode="xref-to" select="(//h:div[@data-type='equation'])[2]">
+  <section data-type="chapter">
+        <div data-type="equation" id="formal_equation">
+          <h5>I am a caption!</h5>
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+    <div data-type="equation" id="formal_equation2">
+      <h5>I am a caption!</h5>
+      <p data-type="tex">$2 + 2 = 4$</p>
+    </div>
+  </section>
+    </x:context>
+    <x:expect label="Gentext should be created for the xref">Equation 1-2</x:expect>
+  </x:scenario>
+
+  <x:scenario label="When an XREF points to a informal equation">
+    <x:context mode="xref-to" select="(//h:div[@data-type='equation'])[1]">
+      <section data-type="chapter">
+      <div data-type="equation">
+        <p data-type="tex">$2 + 2 = 4$</p>
+      </div>
+      </section>
+    </x:context>
+    <x:expect label="Gentext should be created for the xref">???</x:expect>
+  </x:scenario>
+  
+  <x:scenario label="When an XREF points to a formal equation with a caption">
+    <x:context mode="xref-to" select="(//h:div[@data-type='equation'])[1]">
+      <section data-type="chapter">
+        <div data-type="equation" id="formal_equation">
+          <h5/>
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+      </section>
+    </x:context>
+    <x:expect label="Gentext should be created for the xref">Equation 1-1</x:expect>
+  </x:scenario>
+  
+<!-- Equation in a preface -->
+  <x:scenario label="When an XREF points to a formal equation with a caption">
+    <x:context mode="xref-to" select="(//h:div[@data-type='equation'])[1]">
+      <section data-type="preface">
+        <div data-type="equation" id="formal_equation">
+          <h5/>
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+      </section>
+    </x:context>
+    <x:expect label="Gentext should be created for the xref">Equation P-1</x:expect>
+  </x:scenario>
+  
+ <!-- Equation in an appendix -->
+  <x:scenario label="When an XREF points to a formal equation with a caption">
+    <x:context mode="xref-to"  select="(//h:div[@data-type='equation'])[3]">
+      <section data-type="appendix">
+        <div data-type="equation" id="formal_equation">
+          <h5/>
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+        <div data-type="equation" id="formal_equation2">
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+        <div data-type="equation" id="formal_equation3">
+          <h5/>
+          <p data-type="tex">$2 + 2 = 4$</p>
+        </div>
+      </section>
+    </x:context>
+    <x:expect label="Gentext should be created for the xref">Equation A-2</x:expect>
+  </x:scenario>
+ <!-- Begin Chris's Equation work -->
+  
   <!-- Tests for text nodes of <a> elements that do not have data-type="xref" -->
   <x:scenario label="If an 'a' element does not contain data-type='xref'">
     <x:context>