Summary

Include schema.org accessibility metadata to enable discovery no matter how the publication is distributed or consumed.

Properties

The schema.org CreativeWork class includes properties a set of properties used to identify the accessible qualities of a publication. This metadata can be expressed in HTML documents using RDFa or microdata attributes to identify the accessible qualities of the content (e.g., videos). It can also be included in the EPUB package document to provide an overall picture of the accessibility of the given rendition of the publication.

For more information about how to use each property, refer to their respective knowledge base pages:

Note

Although accessibilityAPI and accessibilityControl are also schema.org accessibility properties, they are rarely used for describing digital publications.

Examples

Example 1 — Package Document metadata (EPUB 3)

The following example shows a typical set of metadata for a math textbook with MathML and described images, and that includes accessible scripted content.

<metadata>
  <meta property="schema:accessibilitySummary">
     This publication conforms to WCAG 2.0 Level AA.
  </meta>
  <meta property="schema:accessMode">textual</meta>
  <meta property="schema:accessMode">visual</meta>
  <meta property="schema:accessModeSufficient">textual</meta>
  <meta property="schema:accessibilityFeature">structuralNavigation</meta>
  <meta property="schema:accessibilityFeature">MathML</meta>
  <meta property="schema:accessibilityFeature">alternativeText</meta>
  <meta property="schema:accessibilityFeature">longDescription</meta>
  <meta property="schema:accessibilityHazard">noFlashingHazard</meta>
  <meta property="schema:accessibilityHazard">noSoundHazard</meta>
  <meta property="schema:accessibilityHazard">noMotionSimulationHazard</meta>
  …
</metadata>
Example 2 — Package Document metadata (EPUB 2)

The following is a partial rendering of Example 1 that shows the slightly different syntax used in the EPUB 2 package document (i.e., the use of name and content attributes.

<metadata>
  <meta name="schema:accessibilitySummary" content="This publication conforms to WCAG 2.0 Level AA."/>
  <meta name="schema:accessMode" content="textual"/>
  …
</metadata>
Example 3 — Audiobook manifest metadata

The following example reformulates Example 1 in JSON for use in an Audiobook manifest.

…
  "accessibilitySummary": "This publication conforms to WCAG 2.0 Level AA.",
  "accessMode": ["textual", "visual"],
  "accessModeSufficient" : [
    {
      "type": "ItemList",
      "itemListElement": [textual]
    }
  ],
  "accessibilityFeature": ["structuralNavigation", "MathML", "alternativeText", "longDescription"],
  "accessibilityHazard": ["noFlashingHazard", "noSoundHazard", "noMotionSimulationHazard"],
  …
Example 4 — Embedded metadata (RDFa)

Accessibility metadata that describes a single video is included within the body of an HTML document.

<div vocab="http://www.schema.org" typeof="VideoObject" property="video">
  <video controls="controls" src="croc.mp4"/>
  <meta property="accessibilityFeature" content="captions"/>
  <meta property="accessibilityFeature" content="transcript"/>
  <meta property="accessibilityHazard" content="none"/>
  <p>A transcript of the video follows:</p>
  …
</div>

Related Links