From 841681fc0e6b48dd6a88f537356c6a01614891f0 Mon Sep 17 00:00:00 2001
From: Mark Raynsford <code@io7m.com>
Date: Thu, 3 Feb 2022 22:02:36 +0000
Subject: [PATCH] Fix comments

This fixes an issue where comments in a file would cause processing
to fail.

Affects: https://github.com/io7m/xstructural/issues/18
---
 README-CHANGES.xml                                  | 13 +++++++++++--
 .../com/io7m/xstructural/tests/example0_70.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example0_80.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example1_70.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example1_80.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example2_70.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example2_80.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example3_70.xml      |  4 ++++
 .../com/io7m/xstructural/tests/example3_80.xml      |  4 ++++
 .../xstructural/xml/s7/xstructural7-web-multi.xsl   |  2 ++
 .../xstructural/xml/s7/xstructural7-web-single.xsl  |  2 ++
 .../xstructural/xml/s8/xstructural8-web-multi.xsl   |  2 ++
 .../xstructural/xml/s8/xstructural8-web-single.xsl  |  2 ++
 13 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/README-CHANGES.xml b/README-CHANGES.xml
index b43acba..211707d 100644
--- a/README-CHANGES.xml
+++ b/README-CHANGES.xml
@@ -24,14 +24,23 @@
         <c:change date="2020-12-19T00:00:00+00:00" summary="Slightly improve the CSS for table elements"/>
       </c:changes>
     </c:release>
-    <c:release date="2021-06-27T16:34:56+00:00" is-open="true" ticket-system="com.github.io7m.xstructural" version="1.3.0">
+    <c:release date="2022-02-03T00:00:00+00:00" is-open="false" ticket-system="com.github.io7m.xstructural" version="1.3.0">
       <c:changes>
         <c:change date="2021-06-27T00:00:00+00:00" summary="Add EPUB support">
           <c:tickets>
             <c:ticket id="13"/>
           </c:tickets>
         </c:change>
-        <c:change date="2021-06-27T16:34:56+00:00" summary="Fix a schema bug that rejected valid footnotes in documents"/>
+        <c:change date="2021-06-27T00:00:00+00:00" summary="Fix a schema bug that rejected valid footnotes in documents"/>
+      </c:changes>
+    </c:release>
+    <c:release date="2022-02-03T22:01:54+00:00" is-open="true" ticket-system="com.github.io7m.xstructural" version="1.4.0">
+      <c:changes>
+        <c:change date="2022-02-03T22:01:54+00:00" summary="Fix a bug where documents with comments would be rejected">
+          <c:tickets>
+            <c:ticket id="18"/>
+          </c:tickets>
+        </c:change>
       </c:changes>
     </c:release>
   </c:releases>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_70.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_70.xml
index fbbd347..122a9f0 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_70.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_70.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:7:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_80.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_80.xml
index 3cb05a6..0f2fcb7 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_80.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example0_80.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:8:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_70.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_70.xml
index 65432e3..40cff89 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_70.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_70.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:7:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_80.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_80.xml
index 41c9cc8..6ff5332 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_80.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example1_80.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:8:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_70.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_70.xml
index 316de3c..f6d8c1a 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_70.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_70.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:7:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_80.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_80.xml
index 6f143ec..6d8adb0 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_80.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example2_80.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:8:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_70.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_70.xml
index 69e95ac..dbd0b1d 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_70.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_70.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:7:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_80.xml b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_80.xml
index 2e81d78..cc6e954 100644
--- a/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_80.xml
+++ b/com.io7m.xstructural.tests/src/test/resources/com/io7m/xstructural/tests/example3_80.xml
@@ -1,10 +1,14 @@
 <?xml version="1.0" encoding="UTF-8" ?>
 
+<!-- Comments! -->
+
 <Document xmlns="urn:com.io7m.structural:8:0"
           xmlns:dc="http://purl.org/dc/elements/1.1/"
           tableOfContentsDepth="3"
           tableOfContents="true">
 
+  <!-- Comments! -->
+
   <Metadata>
     <dc:contributor>A Contributor</dc:contributor>
     <dc:creator>A Creator</dc:creator>
diff --git a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-multi.xsl b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-multi.xsl
index 949e363..ce9af1b 100644
--- a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-multi.xsl
+++ b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-multi.xsl
@@ -37,6 +37,8 @@
                  select="concat('Unexpectedly reached catch-all template: ', namespace-uri(.), ':',  node-name(.))"/>
   </xsl:template>
 
+  <xsl:template match="comment()"/>
+
   <!--                                -->
   <!-- Top-level web multi templates. -->
   <!--                                -->
diff --git a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-single.xsl b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-single.xsl
index 0798ea6..96095d7 100644
--- a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-single.xsl
+++ b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s7/xstructural7-web-single.xsl
@@ -36,6 +36,8 @@
                  select="concat('Unexpectedly reached catch-all template: ', namespace-uri(.), ':',  node-name(.))"/>
   </xsl:template>
 
+  <xsl:template match="comment()"/>
+
   <!--                                 -->
   <!-- Top-level web single templates. -->
   <!--                                 -->
diff --git a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-multi.xsl b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-multi.xsl
index f702b98..3e260c0 100644
--- a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-multi.xsl
+++ b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-multi.xsl
@@ -37,6 +37,8 @@
                  select="concat('Unexpectedly reached catch-all template: ', namespace-uri(.), ':',  node-name(.))"/>
   </xsl:template>
 
+  <xsl:template match="comment()"/>
+
   <!--                                -->
   <!-- Top-level web multi templates. -->
   <!--                                -->
diff --git a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-single.xsl b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-single.xsl
index a880400..8f6af26 100644
--- a/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-single.xsl
+++ b/com.io7m.xstructural.xml/src/main/xsl/com/io7m/xstructural/xml/s8/xstructural8-web-single.xsl
@@ -36,6 +36,8 @@
                  select="concat('Unexpectedly reached catch-all template: ', namespace-uri(.), ':',  node-name(.))"/>
   </xsl:template>
 
+  <xsl:template match="comment()"/>
+
   <!--                                 -->
   <!-- Top-level web single templates. -->
   <!--                                 -->