feat: revert the spine/toc nav order check to a WARNING (#1056)

* feat: revert the spine/toc nav order check to a WARNING As agreed on the 2019-07-11 EPUB CG call: https://www.w3.org/2019/07/11-epub3cg-minutes.html - changes the behavior introduced in #999 - adds an INFO message about NAV_011 being subject to change Fixes #1036
w3c · Jul 17, 2019 · 1f6a882 · 1f6a882
1 parent ead7480
commit 1f6a882
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 5 deletions.
diff --git a/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java b/src/main/java/com/adobe/epubcheck/messages/DefaultSeverities.java
@@ -34,6 +34,8 @@ private void initialize()
     {
       return;
     }
+    // Info
+    severities.put(MessageId.INF_001, Severity.INFO);
 
     // Accessibility
     severities.put(MessageId.ACC_001, Severity.USAGE);
@@ -154,7 +156,7 @@ private void initialize()
     severities.put(MessageId.NAV_008, Severity.USAGE);
     severities.put(MessageId.NAV_009, Severity.ERROR);
     severities.put(MessageId.NAV_010, Severity.ERROR);
-    severities.put(MessageId.NAV_011, Severity.ERROR);
+    severities.put(MessageId.NAV_011, Severity.WARNING);
 
     // NCX
     severities.put(MessageId.NCX_001, Severity.ERROR);

diff --git a/src/main/java/com/adobe/epubcheck/messages/MessageId.java b/src/main/java/com/adobe/epubcheck/messages/MessageId.java
@@ -28,6 +28,9 @@
 
 public enum MessageId implements Comparable<MessageId>
 {
+  // General info messages
+  INF_001("INF-001"),
+
   // Messages relating to accessibility
   ACC_001("ACC-001"),
   ACC_002("ACC-002"),

diff --git a/src/main/java/com/adobe/epubcheck/opf/XRefChecker.java b/src/main/java/com/adobe/epubcheck/opf/XRefChecker.java
@@ -548,6 +548,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio
       report.message(MessageId.NAV_011,
           EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),
           (ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);
+      report.message(MessageId.INF_001,
+          EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");
       lastSpinePosition = targetSpinePosition;
       lastAnchorPosition = -1;
     }
@@ -570,6 +572,8 @@ private void checkReadingOrder(Queue<Reference> references, int lastSpinePositio
         report.message(MessageId.NAV_011,
             EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber),
             (ref.type == Type.NAV_TOC_LINK) ? "toc" : "page-list", ref.value, orderContext);
+        report.message(MessageId.INF_001,
+            EPUBLocation.create(ref.source, ref.lineNumber, ref.columnNumber), "ERROR", "https://github.com/w3c/publ-epub-revision/issues/1283");
       }
       lastAnchorPosition = targetAnchorPosition;
     }

diff --git a/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties b/src/main/resources/com/adobe/epubcheck/messages/MessageBundle.properties
@@ -1,5 +1,8 @@
 # This is the default MessageBundle.properties file
 
+#Info
+INF_001=The previous rule is under review and may change to an '%1$s' in a future release. See the discussion at %2$s
+
 #Accessibility
 ACC_001='img' or 'area' HTML element has no 'alt' attribute.
 ACC_002='input' HTML element is not referenced by a corresponding label element.

diff --git a/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java b/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java
@@ -213,15 +213,17 @@ public void testValidateNav_TocInReadingOrder()
   public void testValidateNav_TocWrongOrderInSpine()
   {
     // test that toc nav links MUST be in spine order 
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-toc-unordered-spine");
   }
 
   @Test
   public void testValidateNav_TocWrongOrderOfFragments()
   {
     // test that toc nav links MUST be in document order
-    expectedErrors.addAll(Collections.nCopies(2, MessageId.NAV_011));
+    expectedWarnings.addAll(Collections.nCopies(2, MessageId.NAV_011));
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-toc-unordered-fragments");
   }
 
@@ -236,15 +238,17 @@ public void testValidateNav_PageListInReadingOrder()
   public void testValidateNav_PageListWrongOrderInSpine()
   {
     // test that page-list nav links MUST be in spine order 
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-page-list-unordered-spine");
   }
 
   @Test
   public void testValidateNav_PageListWrongOrderOfFragments()
   {
     // test that page-list nav links MUST be in document order
-    expectedErrors.add(MessageId.NAV_011);
+    expectedWarnings.add(MessageId.NAV_011);
+    expectedInfos.add(MessageId.INF_001);
     testValidateDocument("invalid/nav-page-list-unordered-fragments");
   }