Difference between revisions of "WebSchemas/Accessibility"

From W3C Wiki
Jump to: navigation, search
(Splitting out the agreed vocab (keeping it here) from the rest, on a new Accessibility/ToDo page)
(Splitting out the agreed vocab (keeping it here) from the ongoing work, now on a new Accessibility/ToDo page)
Line 1: Line 1:
{{Template:SchemaDotOrgProposal|name=Accessibility schema|status=Proposal}}
== Vocabulary ==
== Vocabulary ==

Revision as of 22:38, 26 November 2013


The Accessibility terms for Schema.org are still under development. Authors are strongly encouraged to use the terms that are already agreed, which are described in this page. Information on the ongoing development is tracked in other pages, and comment is welcome.

(These expected values are in many cases derived from the IMS Global Access for All (AfA) Information Model Data Element Specification, and there is more information there on some terms.)

Accessibility terms (Version 1.0)

Property Expected Type Expected Values Description
accessibilityFeature Text
  • alternativeText
  • audioDescription
  • braille
  • captions
  • ChemML
  • displayTransformability
  • enhancedAudio
  • highContrast
  • largePrint
  • latex
  • longDescription
  • MathML
  • resizeText
  • signLanguage
  • structuralNavigation
  • tactileGraphic
  • tactileObject
  • transcript
Content features of the resource, such as accessible media, supported enhancements for accessibility and alternatives. See the AccessibilityFeature in more depth explanation for more detail on the three different types of access features available.
accessibilityHazard Text
  • flashing
  • noFlashing
  • motionSimulation
  • noMotionSimulation
  • sound
  • noSound
A characteristic of the described resource that is physiologically dangerous to some users. This is related to WCAG 2.0 guideline 2.3. All three of the negative properties should be set if there are none of the hazards known to date. If no properties are set, the state of accessibilityHazards is unknown, rather than no hazard. If the content does have a hazard, it would have positive assertions for the hazards it has and negative assertions for the others.
accessibilityAPI Text
  • AndroidAccessibility
  • ARIA
  • ATK
  • AT-SPI
  • BlackberryAccessibility
  • iAccessible2
  • iOSAccessibility
  • JavaAccessibility
  • MacOSXAccessibility
  • MSAA
  • UIAutomation
Indicates that the resource is compatible with the referenced accessibility API.
accessibilityControl Text
  • fullAudioControl
  • fullKeyboardControl
  • fullMouseControl
  • fullTouchControl
  • fullVideoControl
  • timing
Identifies one or more input methods can be used that allow access to all of the application functionality.

AccessFeature in more depth

The property accessFeature has multiple property values. Each of these is worth a short description. First, there are three types of accessFeatures: transform, structure and augmentation.

  • Transform acccessFeatures are transformations of or enhancements to content that make it more accessible without changing the access mode. A large print book is a good example of this.
  • Structure accessFeatures describe the access aids that are provided to work within the media, such as the use of a table of contents, index or other items to be able to navigate to a point in content easily without linear scanning.
  • Augmentation accessFeatures make the content in one accessMode available in a different one. The augmentation type that most people are familiar with is alternativeText, which people have learned to apply to HTML images. While transform and structure accessFeatures do not require intelligence to apply, an augmentation normally will. As such, their quality cannot always be counted on.

There are three tables below, one for each of the types of accessFeatures. The extensions that can be used are unique to each of the types.

AccessFeature for transformation

Transform accessFeatures either state how content is available in a transformed state or is set up so that a user can transform it. These properties derive from WCAG 2.0 section 1.4 and surrounding areas. Common refinement/extensions of the property value are

  • /nnn (a specific pointsize, common for large print)
  • /CSSEnabled - that the resource has been designed to be mutable through CSS in an appropriate viewer
  • /yellowOnBlack or other specific common color combinations (for high contrast)

Expected Values Transformed Access Mode Description
  • highContrast
Visual, Textual can add most comment colors as extensions, such as highContrast/yellowOnBlack, greenOnBlack, whiteOnBlack and blackOnWhite or just say /CSSEnabled if CSS is set up to allow these changes to be customized by the user.
  • largePrint
Visual, Textual can add specific pointsize, as in largePrint/18 or just /CSSEnabled. Printed books (Visual) would never use the /CSSEnabled: that would be limited to electronic texts. A physical book would, if any extension, use a pointsize.
  • resizeText
Textual either /CSSEnabled or the extension /taggedPDF if the PDF allows resize and reflow.
  • displayTransformability
Textual The document is set up for CSS display transformability.
  • enhancedAudio
Auditory For prerecorded audio content that contains primarily speech in the foreground.
  • /noBackground
  • /reducedBackground
  • /switchableBackground

AccessFeature for structure

There is only one property value for structuralNavigation, which is listed below.

Expected Values Description
  • structuralNavigation
table of contents or similar resource to allow higher-level document navigation, which can be extended as /tableofContents, /index, /headings, /tags, /bookmarks, /printedPageNumber if one wants to give more detail

AccessFeature for augmentation

Augmentation is the most interesting of the accessFeatures. It explains how an intelligent actor (generally a person, but could be computer-based) will take the intellectual content of one access mode and make it available in a different access mode. One can debate whether the source or the destination access mode is of more importance; I have chosen to organize this by the destination access mode that the source access mode was augmented to. Note that there is a common extension that is used to represent the refinement of the visual content types (see all of the /*OnVisual in access modes). so that one can express accessFeatures for specific parts of the visual content.

  • /text
  • /math
  • /chem
  • /diagram
  • /chart
  • /music

Expected Values Augmented Access Mode Source Access Mode (before augmentation) Description
  • alternativeText
Textual Visual alternative text is provided for visual content (e.g., the HTML alt attribute).
  • longDescription
Textual Visual descriptions are provided for image-based visual content and/or complex structures such as tables, mathematics, diagrams or charts.
  • ChemML
  • laTex
  • MathML
Textual Visual The use of one of these specific ASCII/XML encodings for mathematics or chemistry. These can have extensions specified, but are rarely needed.
  • transcript
Textual Auditory The addition of a separate transcript to convey the meaning of the audio.
  • captions
Visual Auditory The addition of synchronized text (closed captions) to convey the meaning of the audio. Note that while many captions may be implemented as textual in the transport, users think of them as being a visual appearance.
  • signLanguage
Visual Auditory The presentation of audio in sign language in the visual presentation. The most likely extension is /sgn-en-us or other ISO 639 sign language code.
  • audioDescription
Auditory Visual Audio descriptions are available (e.g., via the HTML5 track element). Common extensions are for the various "onImage" refinements noted above.
  • braille
Tactile Visual or Textual braille content or alternative is available (e.g., eBraille or print braille) This can have extensions for the different types of braille, /ASCII, /music, /math, /chem or /nemeth) (also consider /contracted and /gradeII or other nomenclature... pretty open)
  • tactileGraphic
Tactile Visual tactile graphics have been provided, as described in the BANA Guidelines and Standards for Tactile Graphics.
  • tactileObject
Tactile Visual tactile 3D objects have been defined and a 3D object or instructions to build one are available.

Example Markup

Example 1 (Book)

The following example shows how the accessibility metadata will be used to enhance Bookshare records. Note that our markuup has advanced since this early illustrative example. A description and the process and a corpus of searchable books can be found at the accessibility metadata website.

More examples are referenced in the Discussion and Related Work section. Note that there has been discussion of the accessMode (which would have a value of textual and visual" and isAdaptation, which would be urn:isbn:9780030426599, but these are still in flux and have been removed from the example)

  1. <div itemscope="" itemtype="http://schema.org/Book">
  2.    <meta itemprop="bookFormat" content="EBook/DAISY3"/>
  3.    <meta itemprop="accessibilityFeature" content="largePrint/CSSEnabled"/>
  4.    <meta itemprop="accessibilityFeature" content="highContrast/CSSEnabled"/>
  5.    <meta itemprop="accessibilityFeature" content="resizeText/CSSEnabled"/>
  6.    <meta itemprop="accessibilityFeature" content="displayTransformability"/>
  7.    <meta itemprop="accessibilityFeature" content="longDescription"/>
  8.    <meta itemprop="accessibilityFeature" content="alternativeText"/>
  9.    <meta itemprop="accessibilityControl" content="fullKeyboardControl"/>
  10.    <meta itemprop="accessibilityControl" content="fullMouseControl"/>
  11.    <meta itemprop="accessibilityHazard" content="noFlashing"/>
  12.    <meta itemprop="accessibilityHazard" content="noMotionSimulation"/>
  13.    <meta itemprop="accessibilityHazard" content="noSound"/>
  14.    <meta itemprop="accessibilityAPI" content="ARIA"/>
  15.    <dl>
  16.       <dt>Name:</dt>
  17.       <dd itemprop="name">Holt Physical Science</dd>
  18.       <dt>Brief Synopsis:</dt>
  19.       <dd itemprop="description">NIMAC-sourced textbook</dd>
  20.       <dt>Long Synopsis:</dt>
  21.       <dd>N/A</dd>
  22.       <dt>Book Quality:</dt>
  23.       <dd>Publisher Quality</dd>
  24.       <dt>Book Size:</dt>
  25.       <dd itemprop="numberOfPages">598 Pages</dd>
  26.       <dt>ISBN-13:</dt>
  27.       <dd itemprop="isbn">9780030426599</dd>
  28.       <dt>Publisher:</dt>
  29.       <dd itemprop="publisher" itemtype="http://schema.org/Organization" itemscope="">Holt, Rinehart and Winston</dd>
  30.       <dt>Date of Addition:</dt>
  31.       <dd>06/08/10</dd>
  32.       <dt>Copyright Date:</dt>
  33.       <dd itemprop="copyrightYear">2007</dd>
  34.       <dt>Copyrighted By:</dt>
  35.       <dd itemprop="copyrightHolder" itemtype="http://schema.org/Organization" itemscope="">Holt, Rinehart and Winston</dd>
  36.       <dt>Adult content:</dt>
  37.       <dd><meta itemprop="isFamilyFriendly" content="true"/>No</dd>
  38.       <dt>Language:</dt>
  39.       <dd><meta itemprop="inLanguage" content="en-US"/>English US</dd>
  40.       <dt>Essential Images:</dt>
  41.       <dd>861</dd>
  42.       <dt>Described Images:</dt>
  43.       <dd>910</dd>
  44.       <dt>Categories:</dt>
  45.       <dd><span itemprop="genre">Educational Materials</span></dd>
  46.       <dt>Grade Levels:</dt>
  47.       <dd>Sixth grade, Seventh grade, Eighth grade</dd>
  48.       <dt>Submitted By:</dt>
  49.       <dd>Bookshare Staff</dd>
  50.       <dt>NIMAC:</dt>
  51.       <dd>This book is currently only available to public K-12 schools and organizations in the United States for use with students with an IEP, because it was created from files supplied by the NIMAC under these restrictions. Learn more in the NIMAC Support Center.</dd>
  52.    </dl>
  54.    <div class="bookReviews" itemprop="aggregateRating" itemscope itemtype="http://schema.org/AggregateRating">
  55.       <h2>Reviews of Holt Physical Science (<span itemprop="reviewCount">0</span> reviews)</h2>
  57.       <div class="bookReviewScore">
  58.          <span><span itemprop="ratingValue>0</span> - No Rating Yet</span>
  59.       </div>
  60.    </div>
  61. </div>

(The source record can be found at https://www.bookshare.org/browse/book/190639.)

Example 2 (Video)

This example shows how the accessibility metadata can be used to augment a record for a video. Note that the access modes appear in the content for this page, but do not have accesssibility metadata tags added, as this is not in the 1.0 specification. Neither is hasAdapation, which would have a URL like to <a itemprop="hasAdaptation" href="http://www.teachersdomain.org/asset/echo07_vid_climate_dvs/">

  1. <dl itemtype="http://schema.org/VideoObject" itemscope="">
  2.   <dt>Title:</dt>
  3.   <dd itemprop="name">Arctic Climate Perspectives</dd>
  4.   <dt>Description:</dt>
  5.   <dd itemprop="description">This video, adapted from material provided by the ECHO partners,
  6.     describes how global climate change is affecting Barrow, Alaska.</dd>
  7.   <dt>Adaptation Type:</dt>
  8.   <dd><span itemprop="accessibilityFeature">captions</span></dd>
  9.   <dt>Access Mode:</dt>
  10.   <!-- note that the spans in the next line are not in the immediate proposal -->
  11.   <dd>auditory, visual</dd>
  12.   <dt>URL:</dt>
  13.   <dd><a itemprop="url" href="http://www.teachersdomain.org/asset/echo07_vid_climate">http://www.teachersdomain.org/asset/echo07_vid_climate</a>/</dd>
  14.   <dt>Has Adaptation:</dt>
  15.   <dd>http://www.teachersdomain.org/asset/echo07_vid_climate_dvs/</dd>
  16.   <dt>Subjects:</dt>
  17.   <dd><span itemprop="about">National K-12 Subject::Science::Earth and Space Science::Water Cycle, Weather,
  18.     and Climate::Structure and Composition of the Atmosphere, National K-12 Subject::Science::Earth and
  19.     Space Science::Water Cycle, Weather, and Climate::Climate</span></dd>
  20.   <dt>Education Level:</dt>
  21.   <dd>Grade 6, Grade 7, Grade 8, Grade 9</dd>
  22.   <dt>Audience:</dt>
  23.   <dd><span itemprop="intendedEndUserRole">Learner</span></dd>
  24.   <dt>Resource Type:</dt>
  25.   <dd><span itemprop="genre">Audio/Visual</span>, <span itemprop="genre">Movie/Animation</span></dd>
  26.   <dt>Language:</dt>
  27.   <dd><span itemprop="inLanguage">en-US</span></dd>
  28.   <dt>Publication Date:</dt>
  29.   <dd itemprop="datePublished">2007-02-12</dd>
  30.   <dt>Rights:</dt>
  31.   <dd>Download and Share, <a itemprop="useRightsUrl" href="http://www.teachersdomain.org/oerlicense/2/">http://www.teachersdomain.org/oerlicense/2/</a></dd>
  32. </dl>

Issues Tracker and Open Issues

Issue Tracker, both open and closed

This list will be updated afte rthe first meeting

  • stuff (referring to open items, by name and number)

Discussion and Related Work