feat: warn about doc-endnote or doc-biblioentry on list items

rdeltour · rdeltour · commit 5c391579050f · 2023-07-07T15:13:27.000+02:00
The roles `doc-endnote` and `doc-biblioentry` are deprecated in ARIA 1.1, and authors should not use them on list items.

The HTML validator (validator.nu) raises an error when these roles are set on `li` elements.

This commit implements a more permissive approach for EPUBCheck:
- the roles are re-added the HTML schema
- we raise a warning (RSC-017) when the roles are present on `li` elements
diff --git a/src/main/resources/com/adobe/epubcheck/schema/30/epub-xhtml-30.sch b/src/main/resources/com/adobe/epubcheck/schema/30/epub-xhtml-30.sch
@@ -396,5 +396,14 @@
                     select="local-name(ancestor::$ancestor)"/> elements.</report>
         </rule>
     </pattern>
+    
+    <pattern id="dpub-aria.doc-endnote.deprecated">
+        <rule context="h:*[@role]">
+            <report test="tokenize(@role,'\s+')='doc-endnote'"
+                >WARNING: The "doc-endnote" role is deprecated and should not be used.</report>
+            <report test="tokenize(@role,'\s+')='doc-biblioentry'"
+                >WARNING: The "doc-biblioentry" role is deprecated and should not be used.</report>
+        </rule>
+    </pattern>
 
 </schema>
diff --git a/src/main/resources/com/adobe/epubcheck/schema/30/mod/html5/block.rnc b/src/main/resources/com/adobe/epubcheck/schema/30/mod/html5/block.rnc
@@ -101,6 +101,8 @@
 			|	common.attrs.aria.role.treeitem
 			|	common.attrs.aria.role.separator
 			|	common.attrs.aria.role.presentation
+			|	common.attrs.aria.role.doc-biblioentry
+			|	common.attrs.aria.role.doc-endnote
 			)?
 		)
 	li.inner =
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
@@ -170,9 +170,14 @@ Feature: EPUB 3 — Content Documents — XHTML
     When checking document 'aria-roles-img-valid.xhtml'
     Then no errors or warnings are reported
 
-  Scenario: Verify the DPUB-ARIA roles allowed on `li`
-    When checking document 'aria-roles-li-valid.xhtml'
-    Then no errors or warnings are reported
+  Scenario: Report deprecated DPUB-ARIA roles on `li`
+    When checking document 'aria-roles-li-deprecated-warning.xhtml'
+    Then following warnings are reported:
+      | RSC-017 | "doc-endnote" role is deprecated |
+      | RSC-017 | "doc-endnote" role is deprecated |
+      | RSC-017 | "doc-biblioentry" role is deprecated |
+      | RSC-017 | "doc-biblioentry" role is deprecated |
+    Then no other errors or warnings are reported
 
   Scenario: Verify the DPUB-ARIA roles allowed on `nav`
     When checking document 'aria-roles-nav-valid.xhtml'
diff --git a/src/test/resources/epub3/06-content-document/files/aria-roles-li-deprecated-warning.xhtml b/src/test/resources/epub3/06-content-document/files/aria-roles-li-deprecated-warning.xhtml
@@ -11,12 +11,18 @@
 			<ol>
 				<li role="doc-endnote">…</li>
 			</ol>
+			<div role="list">
+				<div role="doc-endnote">1.</div>
+		  </div>
 		</section>
 		<section role="doc-bibliography">
 			<h2>Bibliography</h2>
 			<ul>
 				<li role="doc-biblioentry">…</li>
 			</ul>
+			<div role="list">
+				<div role="doc-biblioentry">1.</div>
+			</div>
 		</section>
 	</body>
 </html>

Original file line number	Diff line number	Diff line change
`@@ -101,6 +101,8 @@`
`101`	`101`	`\| common.attrs.aria.role.treeitem`
`102`	`102`	`\| common.attrs.aria.role.separator`
`103`	`103`	`\| common.attrs.aria.role.presentation`
	`104`	`+ \| common.attrs.aria.role.doc-biblioentry`
	`105`	`+ \| common.attrs.aria.role.doc-endnote`
`104`	`106`	`)?`
`105`	`107`	`)`
`106`	`108`	`li.inner =`