feat: allow epub:type on SVG renderable elements

rdeltour · rdeltour · commit 6cd9789ca94a · 2023-04-28T14:55:38.000+02:00
Update the SVG schemas to allow the "epub:type" attribute on all renderable elements, as suggested in w3c/epub-specs#2556. Note: this is a willful violation of the EPUB 3.3 spec, which (at the time of writing) only allows the attribute on structural, shape, and text elements. Fix #1497
diff --git a/src/main/resources/com/adobe/epubcheck/schema/30/mod/epub-svg-forgiving-inc.rnc b/src/main/resources/com/adobe/epubcheck/schema/30/mod/epub-svg-forgiving-inc.rnc
@@ -83,34 +83,32 @@
   #
   # Note: an element in this list also needs to be added to the
   # exception clause in the `svg.anyother.elem` class
-  svg.structural.elem =
-    ( element defs { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element g { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element svg { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element symbol { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element use { svg.any.inner & svg.epubtype.allowed.attrs }
-    )
-  svg.shape.elem =
-    ( element path { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element rect { svg.any.inner & svg.epubtype.allowed.attrs }
+  svg.renderable.elem =
+    ( element a { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element audio { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element canvas { svg.any.inner & svg.epubtype.allowed.attrs }
     | element circle { svg.any.inner & svg.epubtype.allowed.attrs }
     | element ellipse { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element g { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element iframe { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element image { svg.any.inner & svg.epubtype.allowed.attrs }
     | element line { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element polyline { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element path { svg.any.inner & svg.epubtype.allowed.attrs }
     | element polygon { svg.any.inner & svg.epubtype.allowed.attrs }
-    )
-  svg.text.elem =
-    ( element text { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element altGlyph { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element polyline { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element rect { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element svg { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element switch { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element symbol { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element text { svg.any.inner & svg.epubtype.allowed.attrs }
     | element textPath { svg.any.inner & svg.epubtype.allowed.attrs }
-    | element tref { svg.any.inner & svg.epubtype.allowed.attrs }
     | element tspan { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element unknown { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element use { svg.any.inner & svg.epubtype.allowed.attrs }
+    | element video { svg.any.inner & svg.epubtype.allowed.attrs }
     )
   svg.epubtype.allowed.elem =
-    ( svg.structural.elem
-    | svg.shape.elem
-    | svg.text.elem
-    )
+    ( svg.renderable.elem )
 
 ### Any other elements
 
@@ -120,23 +118,28 @@
   svg.anyother.elem = element * -
     ( foreignObject
     | title
-    | defs
-    | g
-    | svg
-    | symbol
-    | use
-    | path
-    | rect
+    | a
+    | audio
+    | canvas
     | circle
     | ellipse
+    | g
+    | iframe
+    | image
     | line
-    | polyline
+    | path
     | polygon
+    | polyline
+    | rect
+    | svg
+    | switch
+    | symbol
     | text
-    | altGlyph
     | textPath
-    | tref
     | tspan
+    | unknown
+    | use
+    | video
     ) { svg.any.inner & svg.epubtype.forbidden.attrs } 
 
 ### Anything
diff --git a/src/test/resources/epub3/06-content-document/content-document-svg.feature b/src/test/resources/epub3/06-content-document/content-document-svg.feature
@@ -47,7 +47,7 @@ Feature: EPUB 3 — Content Documents — SVG
 	@spec @xref:sec-svg-req
   Scenario: Report an `epub:type` attribute used on an element where it is not allowed
     When checking document 'epubtype-not-allowed-error.svg'
-    Then error RSC-005 is reported 3 times
+    Then error RSC-005 is reported 5 times
     And the message contains '"epub:type" not allowed'
     And no other errors or warnings are reported
 
@@ -125,7 +125,7 @@ Feature: EPUB 3 — Content Documents — SVG
   ###  6.2.3 Restrictions on SVG
 
 	#### `foreignObject` element
-	
+
   @spec @xref:sec-svg-restrictions
   Scenario: Verify that `foreignObject` conforming to the rules is allowed
     When checking document 'foreignObject-valid.svg'
diff --git a/src/test/resources/epub3/06-content-document/content-document-xhtml.feature b/src/test/resources/epub3/06-content-document/content-document-xhtml.feature
@@ -932,7 +932,7 @@ Feature: EPUB 3 — Content Documents — XHTML
 
   @spec @xref:sec-xhtml-svg @xref:sec-svg-req
   Scenario: Verify that `epub:type` attribute can be used on SVG
-    When checking document 'svg-with-epubtype-valid.xhtml'
+    When checking document 'svg-epubtype-valid.xhtml'
     Then no errors or warnings are reported
 
   Scenario: Verify that SVG validation erors are reported as USAGE
diff --git a/src/test/resources/epub3/06-content-document/files/epubtype-not-allowed-error.svg b/src/test/resources/epub3/06-content-document/files/epubtype-not-allowed-error.svg
@@ -1,12 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <svg viewBox="0 0 1200 400" xmlns="https://www.w3.org/2000/svg"
-	xmlns:epub="https://www.idpf.org/2007/ops"
-	epub:type="chapter"
-	version="1.1">
+	xmlns:epub="https://www.idpf.org/2007/ops" xmlns:xlink="https://www.w3.org/1999/xlink"
+	epub:type="chapter" version="1.1">
 	<title epub:type="title">invalid</title>
 	<desc epub:type="tip">epub:type is not allowed on `title` or `desc`</desc>
 	<desc>Rectangle</desc>
-	<defs> </defs>
+	<defs epub:type="tip"> </defs>
 	<rect x="10" y="20" width="75" height="30" style="stroke: #333366; fill: #6666cc"/>
 	<foo epub:type="tip"/>
+	<text x="250" y="150">
+		<tref epub:type="notice" xlink:href="#my-text"/></text>
 </svg>
diff --git a/src/test/resources/epub3/06-content-document/files/epubtype-valid.svg b/src/test/resources/epub3/06-content-document/files/epubtype-valid.svg
@@ -4,12 +4,6 @@
 	epub:type="chapter" version="1.1">
 	<title>test</title>
 	<desc>Rectangle</desc>
-	<!-- Structural elements -->
-	<defs epub:type="notice">
-		<rect id="my-rect" width="60" height="10"/>
-		<text id="my-text">hello</text>
-		<path id="my-path" d="M 100 100 L 300 100 L 200 300 z"/>
-	</defs>
 	<g epub:type="notice">
 		<rect x="10" y="20" width="75" height="30"/>
 	</g>
@@ -29,8 +23,6 @@
 	<text epub:type="notice" x="250" y="150">hello</text>
 	<text x="250" y="150">
 		<tspan epub:type="notice">hello</tspan></text>
-	<text x="250" y="150">
-		<tref epub:type="notice" xlink:href="#my-text"/></text>
 	<text>
 		<textPath epub:type="notice" xlink:href="#my-path">Text along path1</textPath>
 	</text>
diff --git a/src/test/resources/epub3/06-content-document/files/epubtype-valid.xhtml b/src/test/resources/epub3/06-content-document/files/epubtype-valid.xhtml
@@ -1,5 +1,6 @@
 <!DOCTYPE html>	 
-<html xmlns="https://www.w3.org/1999/xhtml" xmlns:epub="https://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+<html xmlns="https://www.w3.org/1999/xhtml" xmlns:epub="https://www.idpf.org/2007/ops" xml:lang="en"
+	lang="en">
 	<head>
 		<meta charset="utf-8" />
 		<title>epub:type with SSV semantics</title>
diff --git a/src/test/resources/epub3/06-content-document/files/svg-epubtype-valid.xhtml b/src/test/resources/epub3/06-content-document/files/svg-epubtype-valid.xhtml
@@ -0,0 +1,36 @@
+<!DOCTYPE html>
+<html xmlns="https://www.w3.org/1999/xhtml" xmlns:x="https://www.w3.org/1999/xhtml"
+	xmlns:epub="https://www.idpf.org/2007/ops" xml:lang="en" lang="en">
+	<head>
+		<meta charset="utf-8" />
+		<title>SVG with epub:type embedded in HTML</title>
+	</head>
+	<body>
+		<section>
+			<!--epub:type on SVG `svg` element-->
+			<svg xmlns="https://www.w3.org/2000/svg" epub:type="titlepage"
+				viewBox="0 0 100 100" version="1.1">
+				<desc>Test</desc>
+			</svg>
+			
+			<!--epub:type on SVG `g` element-->
+			<svg xmlns="https://www.w3.org/2000/svg" 
+				viewBox="0 0 100 100" version="1.1">
+				<desc>Test</desc>
+			<circle cx="50" cy="50" r="50"/>
+				<g epub:type="notice">
+				<circle cx="50" cy="50" r="50"/>
+				</g>
+			</svg>
+			
+			<!--epub:type on SVG `a` element-->
+			<svg xmlns="https://www.w3.org/2000/svg" 
+				viewBox="0 0 100 100" version="1.1">
+				<desc>Test</desc>
+				<a epub:type="noteref" href="#note" id="ref">
+				</a>
+			</svg>
+			<p id="note">a note</p>
+		</section>
+	</body>
+</html>
diff --git a/src/test/resources/epub3/06-content-document/files/svg-with-epubtype-valid.xhtml b/src/test/resources/epub3/06-content-document/files/svg-with-epubtype-valid.xhtml
