feat: update the Package Document schema for EPUB 3.2

- partially resolves #883 - only adds the attribute, doesn't check values - fixes #882 - reports if a preceding itemref has a matching idref - fixes #881 - reports presence of bindings - fixes #880 - reports presence of rendition:viewport property in metadata - fixes #879 - reports rendition:spread=portrait in metadata and rendition:spread-portrait on an itemref - fixes #878 - reports presence of meta-auth property in metadata - fixes #877 - reports presence of display-seq in metadata - fixes #876 - reports if term/authority are not used together, or if multiple instances are attached to a single subject
w3c · Jan 14, 2019 · 1f12512 · 1f12512
1 parent 976b9f6
commit 1f12512
Show file tree

Hide file tree

Showing 23 changed files with 129 additions and 62 deletions.
diff --git a/src/main/resources/com/adobe/epubcheck/schema/30/package-30.rnc b/src/main/resources/com/adobe/epubcheck/schema/30/package-30.rnc
@@ -26,7 +26,7 @@
  opf.epub3.meta.content = (opf.property.attr & opf.refines.attr? & opf.id.attr? & opf.scheme.attr? & opf.i18n.attrs & datatype.string.nonempty)
  opf.epub2.meta.content = (attribute name { text } & attribute content { text }) #legacy
 
- opf.link = element link { opf.href.attr & opf.rel.attr & opf.id.attr? & opf.refines.attr? & opf.media-type.attr? } 
+ opf.link = element link { opf.href.attr & opf.rel.attr & opf.id.attr? & opf.refines.attr? & opf.media-type.attr? & opf.properties.attr? } 
 
  opf.property.attr = attribute property { datatype.property }
  opf.rel.attr = attribute rel { datatype.properties }
@@ -129,4 +129,4 @@
  opf.id.attr = attribute id { datatype.ID }
  opf.i18n.attrs = opf.xml.lang.attr? & opf.dir.attr?
  opf.xml.lang.attr = attribute xml:lang { datatype.languagecode }
- opf.dir.attr = attribute dir { 'ltr' | 'rtl' }
+ opf.dir.attr = attribute dir { 'ltr' | 'rtl' }
diff --git a/src/main/resources/com/adobe/epubcheck/schema/30/package-30.sch b/src/main/resources/com/adobe/epubcheck/schema/30/package-30.sch
diff --git a/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java b/src/test/java/com/adobe/epubcheck/api/Epub30CheckExpandedTest.java
@@ -133,19 +133,22 @@ public void testValidateEPUBPLoremForeign()
  @Test
  public void testValidateEPUBPLoremObjectFallbacks()
  {
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("valid/lorem-object-fallbacks", "valid/lorem-object-fallbacks.txt");
  }
 
  @Test
  public void testValidateEPUBPLoremBindings()
  {
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("valid/lorem-bindings", "valid/lorem-bindings.txt");
  }
 
  @Test
  public void testValidateEPUBPLoremInvalidBindings()
  {
  Collections.addAll(expectedErrors, MessageId.MED_002);
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("invalid/lorem-bindings");
  }
 
@@ -560,6 +563,7 @@ public void testIssue249()
  @Test
  public void testValidateEPUB20_issue267()
  {
+ Collections.addAll(expectedWarnings, MessageId.RSC_017, MessageId.RSC_017, MessageId.RSC_017);
  testValidateDocument("valid/issue267/", "valid/issue267.txt");
  }
 

diff --git a/src/test/java/com/adobe/epubcheck/ocf/OCFCheckerTest.java b/src/test/java/com/adobe/epubcheck/ocf/OCFCheckerTest.java
@@ -172,12 +172,12 @@ public void testLoremBindings30()
  {
  ValidationReport testReport = testOcfPackage("/30/expanded/valid/lorem-bindings/",
  EPUBVersion.VERSION_3);
- if (0 != testReport.getErrorCount() || 0 != testReport.getWarningCount())
+ if (0 != testReport.getErrorCount() || 1 != testReport.getWarningCount())
  {
  outWriter.println(testReport);
  }
  assertEquals(0, testReport.getErrorCount());
- assertEquals(0, testReport.getWarningCount());
+ assertEquals(1, testReport.getWarningCount());
 
  assertTrue(testReport.hasInfoMessage("[format version] 3.0.1"));
  }
@@ -217,12 +217,12 @@ public void testLoremFallbacks30()
  {
  ValidationReport testReport = testOcfPackage("/30/expanded/valid/lorem-object-fallbacks/",
  EPUBVersion.VERSION_3);
- if (0 != testReport.getErrorCount() || 0 != testReport.getWarningCount())
+ if (0 != testReport.getErrorCount() || 1 != testReport.getWarningCount())
  {
  outWriter.println(testReport);
  }
  assertEquals(0, testReport.getErrorCount());
- assertEquals(0, testReport.getWarningCount());
+ assertEquals(1, testReport.getWarningCount());
 
  assertTrue(testReport.hasInfoMessage("[format version] 3.0.1"));
  }
@@ -358,7 +358,7 @@ public void testInvalidLoremBindings30()
  {
  ValidationReport testReport = testOcfPackage("/30/expanded/invalid/lorem-bindings/",
  EPUBVersion.VERSION_3);
- if (1 != testReport.getErrorCount() || 0 != testReport.getWarningCount())
+ if (1 != testReport.getErrorCount() || 1 != testReport.getWarningCount())
  {
  outWriter.println(testReport);
  }
@@ -367,7 +367,7 @@ public void testInvalidLoremBindings30()
  List<MessageId> errors = new ArrayList<MessageId>();
  Collections.addAll(errors, MessageId.MED_002);
  assertEquals(errors, testReport.getErrorIds());
- assertEquals(0, testReport.getWarningCount());
+ assertEquals(1, testReport.getWarningCount());
 
  assertTrue(testReport.hasInfoMessage("[format version] 3.0.1"));
  }

diff --git a/src/test/java/com/adobe/epubcheck/opf/OPFCheckerTest.java b/src/test/java/com/adobe/epubcheck/opf/OPFCheckerTest.java
@@ -137,6 +137,7 @@ public void testValidateDocumentValidOPFBase001()
  @Test
  public void testValidateDocumentValidOPFBindings001()
  {
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("valid/bindings-001.opf", EPUBVersion.VERSION_3);
  }
 
@@ -251,6 +252,7 @@ public void testValidateDocumentNoDcNamespace()
  public void testValidateDocumentBindings001()
  {
  Collections.addAll(expectedErrors, MessageId.RSC_005);
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("invalid/bindings-001.opf", EPUBVersion.VERSION_3);
  }
 
@@ -674,6 +676,7 @@ public void testRenditionPropertiesValid()
  @Test
  public void testRenditionGlobalsValid()
  {
+ Collections.addAll(expectedWarnings, MessageId.RSC_017, MessageId.RSC_017, MessageId.RSC_017);
  testValidateDocument("valid/rendition-globals.opf", EPUBVersion.VERSION_3);
  }
 
@@ -690,6 +693,7 @@ public void testRenditionGlobalsDuplicated()
  {
  Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005, MessageId.RSC_005,
  MessageId.RSC_005, MessageId.RSC_005);
+ Collections.addAll(expectedWarnings, MessageId.RSC_017, MessageId.RSC_017);
  testValidateDocument("invalid/rendition-globals-duplicate.opf", EPUBVersion.VERSION_3);
  }
 
@@ -698,6 +702,7 @@ public void testRenditionGlobalsBadValues()
  {
  Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005, MessageId.RSC_005,
  MessageId.RSC_005, MessageId.RSC_005);
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("invalid/rendition-globals-badvalues.opf", EPUBVersion.VERSION_3);
  }
 
@@ -706,6 +711,7 @@ public void testRenditionOverridesConflicts()
  {
  Collections.addAll(expectedErrors, MessageId.RSC_005, MessageId.RSC_005, MessageId.RSC_005,
  MessageId.RSC_005, MessageId.RSC_005);
+ Collections.addAll(expectedWarnings, MessageId.RSC_017);
  testValidateDocument("invalid/rendition-globals-badvalues.opf", EPUBVersion.VERSION_3);
  }
 

diff --git a/src/test/resources/30/epub/invalid/edupub-pagination-nopagelist.epub b/src/test/resources/30/epub/invalid/edupub-pagination-nopagelist.epub
diff --git a/src/test/resources/30/epub/invalid/edupub-pagination-nosource.epub b/src/test/resources/30/epub/invalid/edupub-pagination-nosource.epub
diff --git a/src/test/resources/30/epub/invalid/edupub-toc-missing-branches.epub b/src/test/resources/30/epub/invalid/edupub-toc-missing-branches.epub
diff --git a/src/test/resources/30/epub/valid/edupub-pagination.epub b/src/test/resources/30/epub/valid/edupub-pagination.epub
diff --git a/src/test/resources/30/epub/valid/georgia-cfi.epub b/src/test/resources/30/epub/valid/georgia-cfi.epub
diff --git a/src/test/resources/30/expanded/valid/issue567/OEBPS/package.opf b/src/test/resources/30/expanded/valid/issue567/OEBPS/package.opf
@@ -8,7 +8,6 @@
  <dc:language id="pub-language">en</dc:language>
  <meta property="dcterms:modified">2015-03-13T15:35:14Z</meta>
  <dc:creator id="creator1">xyz</dc:creator>
- <meta refines="#creator1" property="display-seq">1</meta>
  <meta refines="#creator1" property="role" scheme="marc:relators">aut</meta>
  <dc:publisher>xyz</dc:publisher>
  <dc:rights>xyz</dc:rights>

diff --git a/src/test/resources/30/single/opf/invalid/prefix-declaration.opf b/src/test/resources/30/single/opf/invalid/prefix-declaration.opf
@@ -8,7 +8,6 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  </metadata> 
  <manifest>
  <item id="t1" href="lorem.xhtml" properties="nav" media-type="application/xhtml+xml" /> 

diff --git a/src/test/resources/30/single/opf/invalid/prefixes-001.opf b/src/test/resources/30/single/opf/invalid/prefixes-001.opf
@@ -8,8 +8,7 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
- <meta property="media:test meta-auth">test</meta>
+ <meta property="media:test title-type">test</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/30/single/opf/invalid/prefixes-002.opf b/src/test/resources/30/single/opf/invalid/prefixes-002.opf
@@ -8,7 +8,6 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/30/single/opf/invalid/prefixes-003.opf b/src/test/resources/30/single/opf/invalid/prefixes-003.opf
@@ -8,7 +8,6 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="invalid:test">test2</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>

diff --git a/src/test/resources/30/single/opf/invalid/prefixes-004.opf b/src/test/resources/30/single/opf/invalid/prefixes-004.opf
@@ -8,7 +8,6 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/30/single/opf/invalid/scheme-001.opf b/src/test/resources/30/single/opf/invalid/scheme-001.opf
@@ -9,7 +9,6 @@
  <dc:date>2011-09-01</dc:date>
  <meta property="identifier-type" scheme="codelist5">06</meta>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/30/single/opf/invalid/scheme-002.opf b/src/test/resources/30/single/opf/invalid/scheme-002.opf
@@ -9,7 +9,6 @@
  <dc:date>2011-09-01</dc:date>
  <meta property="identifier-type" scheme="onix:codelist5 invalid">06</meta>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/30/single/opf/valid/prefixes.opf b/src/test/resources/30/single/opf/valid/prefixes.opf
@@ -1,4 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<?xml-model href="../../../../../../main/resources/com/adobe/epubcheck/schema/30/epub-nav-30.sch" type="application/xml" schematypens="http://purl.oclc.org/dsdl/schematron"?>
 <package xmlns="http://www.idpf.org/2007/opf" version="3.0" unique-identifier="uid"
  prefix="foaf: http://xmlns.com/foaf/spec/
  dbp: http://dbpedia.org/ontology/">
@@ -8,7 +9,6 @@
  <dc:language>la</dc:language>
  <dc:date>2011-09-01</dc:date>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="media:narrator">test</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>

diff --git a/src/test/resources/30/single/opf/valid/scheme-001.opf b/src/test/resources/30/single/opf/valid/scheme-001.opf
@@ -9,7 +9,6 @@
  <dc:date>2011-09-01</dc:date>
  <meta property="identifier-type" scheme="onix:codelist5">06</meta>
  <meta property="dcterms:modified">2011-09-01T17:18:00Z</meta>
- <meta property="meta-auth">Auth</meta>
  <meta property="foaf:test">test</meta>
  <link rel="marc21xml-record foaf:ddd" href="pub/meta/nor-wood-marc21.xml"/>
  </metadata> 

diff --git a/src/test/resources/com/adobe/epubcheck/test/opf/Media-type_handler_expected_results.json b/src/test/resources/com/adobe/epubcheck/test/opf/Media-type_handler_expected_results.json
@@ -8,7 +8,7 @@
  "elapsedTime" : 144,
  "nFatal" : 0,
  "nError" : 5,
- "nWarning" : 0,
+ "nWarning" : 1,
  "nUsage" : 5
  },
  "publication" : {
@@ -525,6 +525,18 @@
  "context" : null
  } ],
  "suggestion" : null
+ }, {
+ "ID" : "RSC-017",
+ "severity" : "WARNING",
+ "message" : "Warning while parsing file: Use of the bindings element is deprecated",
+ "additionalLocations" : 0,
+ "locations" : [ {
+ "path" : "OPS/content.opf",
+ "line" : 28,
+ "column" : 13,
+ "context" : null
+ } ],
+ "suggestion" : null
  }, {
  "ID" : "SCP-002",
  "severity" : "USAGE",

diff --git a/src/test/resources/com/adobe/epubcheck/test/opf/Publication_Metadata_epub3/OPS/content.opf b/src/test/resources/com/adobe/epubcheck/test/opf/Publication_Metadata_epub3/OPS/content.opf
@@ -12,7 +12,6 @@
  <meta refines="#creator" property="file-as">Doe, John</meta>
  <dc:creator id="creator02">Jane Doe</dc:creator>
  <meta refines="#creator02" property="role" scheme="marc:relators">ill</meta>
- <meta refines="#creator02" property="display-seq">2</meta>
 
  <dc:identifier id="pub-id">urn:uuid:c1541da9-2d2f-4483-8df0-e38c27d3c50d</dc:identifier>
  <dc:identifier id="isbn-id">urn:isbn:978-3-16-148410-0</dc:identifier>

diff --git a/...t/resources/com/adobe/epubcheck/test/opf/Publication_Metadata_epub3_expected_results.json b/...t/resources/com/adobe/epubcheck/test/opf/Publication_Metadata_epub3_expected_results.json
@@ -65,10 +65,10 @@
  "id" : "ePubCheck.NoManifestRef:OPS/content.opf",
  "fileName" : "OPS/content.opf",
  "media_type" : null,
- "compressedSize" : 855,
- "uncompressedSize" : 2104,
+ "compressedSize" : 837,
+ "uncompressedSize" : 2041,
  "compressionMethod" : "Deflated",
- "checkSum" : "5bcf52781e0cb1f525899ada182f4cc569293948438c6adea2fa5614c8a64ce",
+ "checkSum" : "cc4353d73d62d851b4b686701fc63a8957b5453c9972942168bbf9bebe08dd0",
  "isSpineItem" : false,
  "spineIndex" : null,
  "isLinear" : false,