@likecoin/epubcheck-ts 0.1.0

package/schemas/epub-nav-30.sch

@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schema xmlns="http://purl.oclc.org/dsdl/schematron"  queryBinding="xslt2">
+
+    <ns uri="http://www.w3.org/1999/xhtml" prefix="html"/>
+    <ns uri="http://www.idpf.org/2007/ops" prefix="epub"/>
+
+    <pattern id="nav-ocurrence">
+        <rule context="html:body">
+            <assert test="count(.//html:nav[tokenize(@epub:type,'\s+')='toc']) = 1">Exactly one "toc" nav element
+                must be present</assert>
+            <assert test="count(.//html:nav[tokenize(@epub:type,'\s+')='page-list']) &lt; 2">Multiple occurrences of
+                the "page-list" nav element</assert>
+            <assert test="count(.//html:nav[tokenize(@epub:type,'\s+')='landmarks']) &lt; 2">Multiple occurrences of
+                the "landmarks" nav element</assert>
+        </rule>
+    </pattern>
+
+    <pattern id="span-no-sublist">
+        <rule context="html:body//html:nav[@epub:type]//html:span">
+            <assert test="count(.//ol) = 0"> The span element must only be used as heading for flat
+                sublists (not hierarchical navigation structures) </assert>
+        </rule>
+    </pattern>
+
+    <pattern id="landmarks">
+        <rule context="html:nav[tokenize(@epub:type,'\s+')='landmarks']//html:ol//html:a">
+            <let name="current" value="."/>
+            <let name="current_type_normalized" value="tokenize(lower-case(@epub:type),'\s+')"/>
+            <let name="current_href_normalized" value="normalize-space(lower-case(@href))"/>
+
+            <!-- Check for missing epub:type attributes -->
+            <assert test="@epub:type">Missing epub:type attribute on anchor inside "landmarks" nav element</assert>
+
+            <!--
+                landmarks anchors should be unique (#493)
+                and only reported within the same ancestor landmarks element
+            -->
+            <assert test="
+                empty(ancestor::html:nav//html:ol//html:a[
+                    not(. is $current) and
+                    tokenize(lower-case(@epub:type),'\s+') = $current_type_normalized and
+                    normalize-space(lower-case(@href)) = $current_href_normalized
+                    ])">Another landmark was found with the same epub:type and same reference to "<value-of select="$current_href_normalized"/>"</assert>
+        </rule>
+    </pattern>
+
+    <pattern id="link-labels">
+        <rule context="html:nav[@epub:type]//html:ol//html:a">
+            <assert
+                test="string-length(normalize-space(string-join(.|./html:img/@alt|.//@aria-label))) > 0"
+                >Anchors within nav elements must contain text</assert>
+        </rule>
+    </pattern>
+
+    <pattern id="span-labels">
+        <rule context="html:nav[@epub:type]//html:ol//html:span">
+            <assert
+                test="string-length(normalize-space(string-join(.|./html:img/@alt|.//@aria-label))) > 0"
+                >Spans within nav elements must contain text</assert>
+        </rule>
+    </pattern>
+
+    <pattern id="req-heading">
+        <rule
+          context="html:nav[@epub:type][not(tokenize(@epub:type,'\s+') = ('toc','page-list','landmarks'))]">
+            <assert test="child::*[1][self::html:h1|self::html:h2|self::html:h3|self::html:h4|self::html:h5|self::html:h6]">nav
+                elements other than "toc", "page-list" and "landmarks" must have a heading as their
+                first child</assert>
+        </rule>
+    </pattern>
+
+    <pattern id="heading-content">
+        <rule context="html:h1|html:h2|html:h3|html:h4|html:h5|html:h6">
+            <assert
+                test="string-length(normalize-space(string-join(.|./html:img/@alt|.//@aria-label))) > 0"
+                >Heading elements must contain text</assert>
+        </rule>
+    </pattern>
+    
+    <pattern id="flat-nav">
+        <rule context="html:nav[tokenize(@epub:type,'\s+') = ('page-list','landmarks')]">
+            <assert test="count(.//html:ol) = 1">WARNING: A "<value-of select="@epub:type"/>" nav element should contain
+                only a single ol descendant (no nested sublists)</assert>
+        </rule>
+    </pattern>
+
+</schema>

package/schemas/epub-prefix-attr.rng

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns:epub="http://www.idpf.org/2007/ops" xmlns="http://relaxng.org/ns/structure/1.0">
+  <!-- ##################################################################### -->
+  <define name="epub.prefix.attr">
+    <a:documentation> RELAX NG Schema for EPUB: EPUB prefix attributes                  #</a:documentation>
+    <!-- ##################################################################### -->
+    <a:documentation>prefix attributes</a:documentation>
+    <attribute name="prefix">
+      <ref name="datatype.prefixdecl"/>
+    </attribute>
+  </define>
+  <define name="epub.prefix.attr.ns">
+    <attribute name="epub:prefix">
+      <ref name="datatype.prefixdecl"/>
+    </attribute>
+  </define>
+</grammar>

package/schemas/epub-shared-inc.rng

@@ -0,0 +1,29 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0">
+  <!-- ##################################################################### -->
+  <!-- EPUB elements -->
+  <include href="epub-trigger.rng">
+    <a:documentation> RELAX NG Schema for EPUB: shared definitions for inclusion        #</a:documentation>
+    <!-- ##################################################################### -->
+    <a:documentation>Includes</a:documentation>
+  </include>
+  <include href="epub-switch.rng"/>
+  <!-- EPUB attributes -->
+  <include href="epub-prefix-attr.rng"/>
+  <include href="epub-ssml-attrs.rng"/>
+  <include href="epub-type-attr.rng"/>
+  <!-- EPUB integration logic -->
+  <include href="epub-xhtml-integration.rng"/>
+  <!--
+    Note: the default HMTL schema does not define such a category, so we
+    do our best to include what makes sense here
+  -->
+  <define name="common.inner.anyhtml">
+    <a:documentation>Content model: HTML fragments</a:documentation>
+    <choice>
+      <ref name="html.elem"/>
+      <ref name="body.elem"/>
+      <ref name="common.inner.flow"/>
+    </choice>
+  </define>
+</grammar>

package/schemas/epub-ssml-attrs.rng

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns:epub="http://www.idpf.org/2007/ops" xmlns:ssml="http://www.w3.org/2001/10/synthesis" xmlns="http://relaxng.org/ns/structure/1.0">
+  <!-- ##################################################################### -->
+  <define name="epub.ssml.ph.attr">
+    <a:documentation> RELAX NG Schema for EPUB: EPUB SSML attributes                    #</a:documentation>
+    <!-- ##################################################################### -->
+    <a:documentation>SSML attributes</a:documentation>
+    <attribute name="ssml:ph">
+      <ref name="datatype.ssml.PhoneticExpression"/>
+    </attribute>
+  </define>
+  <define name="epub.ssml.alphabet.attr">
+    <attribute name="ssml:alphabet">
+      <ref name="datatype.ssml.PhoneticAlphabet"/>
+    </attribute>
+  </define>
+</grammar>

package/schemas/epub-svg-30.rnc

@@ -0,0 +1,17 @@
+
+# #####################################################################
+##  RELAX NG Schema for EPUB: EPUB SVG (+ XHTML, + MathML)            #
+# #####################################################################
+
+include "./mod/epub-xhtml-svg-mathml.rnc" {
+  start = svg
+  
+  # Override the `id` attribute to require a valid XML ID
+  svg.attr.id = attribute id { xsd:ID }?
+}
+
+# Allow `body` element as a child of `foreignObject` 
+svg.foreignObject.inner |= body.elem 
+
+# Allow `epub:prefix` attribute on `svg` root
+svg.attrs &= epub.prefix.attr.ns?