├── .gitignore ├── .pr-preview.json ├── w3c.json ├── CODE_OF_CONDUCT.md ├── LICENSE.md ├── common ├── css │ └── custom.css └── js │ ├── css-inline.js │ ├── previousRelease.js │ ├── examples.js │ └── permalink-a11y.js ├── CONTRIBUTING.md ├── latest ├── crosswalk │ └── index.html └── index.html ├── README.md ├── crosswalk ├── indexOld.html └── MARC-UNIMARC │ └── Original-Crosswalk-Schema-ONIX-MARC21-UNIMARC.html └── index.html /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | -------------------------------------------------------------------------------- /.pr-preview.json: -------------------------------------------------------------------------------- 1 | { 2 | "src_file": "index.html", 3 | "type": "respec" 4 | } -------------------------------------------------------------------------------- /w3c.json: -------------------------------------------------------------------------------- 1 | { 2 | "group": [134546] 3 | , "contacts": ["iherman"] 4 | , "repo-type": "cg-report" 5 | } 6 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Code of Conduct 2 | 3 | All documentation, code and communication under this repository are covered by the [W3C Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc/). 4 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | All Reports in this Repository are licensed by Contributors 2 | under the 3 | [W3C Software and Document License](http://www.w3.org/Consortium/Legal/2015/copyright-software-and-document). 4 | 5 | Contributions to Specifications are made under the 6 | [W3C CLA](https://www.w3.org/community/about/agreements/cla/). 7 | 8 | Contributions to Test Suites are made under the 9 | [W3C 3-clause BSD License](https://www.w3.org/Consortium/Legal/2008/03-bsd-license.html) 10 | 11 | -------------------------------------------------------------------------------- /common/css/custom.css: -------------------------------------------------------------------------------- 1 | pre, 2 | code { 3 | white-space: break-spaces !important; 4 | } 5 | 6 | fieldset { 7 | border: none; 8 | padding: 0; 9 | margin: 0; 10 | } 11 | 12 | legend { 13 | position: absolute; 14 | left: -9999rem; 15 | overflow: hidden; 16 | } 17 | 18 | div.ex-buttons { 19 | margin: 1rem auto -1rem; 20 | min-width: 45rem; 21 | background-color: rgb(235, 235, 235); 22 | } 23 | 24 | div.ex-buttons input { 25 | background-color: inherit; 26 | border: none; 27 | width: 5rem; 28 | height: 1.6rem; 29 | } 30 | 31 | input.active { 32 | background-color: rgb(250, 250, 250) !important; 33 | } 34 | 35 | p.synonym { 36 | margin-top: -0.5rem; 37 | margin-bottom: 2rem; 38 | padding-top: 0; 39 | font-weight: bold; 40 | font-size: 90%; 41 | } 42 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Schema.org Community Group 2 | 3 | This repository is being used for work in the W3C Schema.org Community Group, governed by the [W3C Community License 4 | Agreement (CLA)](http://www.w3.org/community/about/agreements/cla/). To make substantive contributions, 5 | you must join the CG. 6 | 7 | If you are not the sole contributor to a contribution (pull request), please identify all 8 | contributors in the pull request comment. 9 | 10 | To add a contributor (other than yourself, that's automatic), mark them one per line as follows: 11 | 12 | ``` 13 | +@github_username 14 | ``` 15 | 16 | If you added a contributor by mistake, you can remove them in a comment with: 17 | 18 | ``` 19 | -@github_username 20 | ``` 21 | 22 | If you are making a pull request on behalf of someone else but you had no part in designing the 23 | feature, you can remove yourself with the above syntax. 24 | -------------------------------------------------------------------------------- /common/js/css-inline.js: -------------------------------------------------------------------------------- 1 | 2 | function inlineCustomCSS() { 3 | 4 | var customCSS = getCSS(); 5 | 6 | if (customCSS == '') { return; } 7 | 8 | var style = document.createElement('style'); 9 | style.textContent = customCSS; 10 | 11 | document.getElementsByTagName('head')[0].appendChild(style); 12 | 13 | } 14 | 15 | function getCSS() { 16 | 17 | try { 18 | var xmlhttp = new XMLHttpRequest(); 19 | 20 | xmlhttp.open('GET', 'common/css/custom.css', false); 21 | xmlhttp.send(); 22 | 23 | if (xmlhttp.status == 200) { 24 | return xmlhttp.responseText; 25 | } 26 | else { 27 | console.error('Failed to read CSS file common/css/custom.css. Returned status: ' + xmlhttp.status); 28 | return ''; 29 | } 30 | } 31 | 32 | catch (e) { 33 | console.error(e); 34 | return ''; 35 | } 36 | } 37 | -------------------------------------------------------------------------------- /latest/crosswalk/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Schema.org Accessibility Properties Crosswalk 6 | 7 | 20 | 21 | 22 |

The latest version of the vocabulary is available at 23 | 24 |

25 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /latest/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Schema.org Accessibility Properties for Discoverability Vocabulary 6 | 7 | 20 | 21 | 22 |

The latest version of the vocabulary is available at 23 | 24 |

25 | 30 | 31 | 32 | -------------------------------------------------------------------------------- /common/js/previousRelease.js: -------------------------------------------------------------------------------- 1 | 2 | function addPreviousRelease() { 3 | 4 | if (!respecConfig.hasOwnProperty('previousPublishDate')) { 5 | console.warn('Missing previousPublishDate in respec metadata. Cannot add link to previous release.'); 6 | return; 7 | } 8 | 9 | // respec converts previousPublishDate to a date object, so need to conver to numeric representation 10 | 11 | var ppd = respecConfig['previousPublishDate'].getFullYear() + 12 | (respecConfig['previousPublishDate'].getMonth() + 1).toString().padStart(2,'0') + 13 | (respecConfig['previousPublishDate'].getDate() + 1).toString().padStart(2,'0'); 14 | 15 | var prevLink = '
Previous version:
\ 16 |
https://www.w3.org/community/reports/a11y-discov-vocab/CG-FINAL-' + respecConfig['shortName'] + '-' + ppd + '/
'; 17 | 18 | // get the dt for the latest editor's draft - new link will go before (nth-child not working here, so grabbing all) 19 | var dt = document.querySelectorAll('div.head > dl > dt'); 20 | 21 | if (!dt) { 22 | console.warn('Missing dt element with publication links. Cannot add link to previous release.'); 23 | return; 24 | } 25 | 26 | dt[1].insertAdjacentHTML('beforebegin', prevLink); 27 | } 28 | 29 | -------------------------------------------------------------------------------- /common/js/examples.js: -------------------------------------------------------------------------------- 1 | 2 | function formatExamples() { 3 | 4 | var pre = document.querySelectorAll('pre.epub, pre.json-ld, pre.rdfa, pre.microdata'); 5 | 6 | // hide the non-epub examples 7 | for (var i = 0; i < pre.length; i++) { 8 | if (!pre[i].classList.contains('json-ld')) { 9 | pre[i].setAttribute('hidden', 'hidden'); 10 | } 11 | } 12 | 13 | // add the control buttons 14 | var buttons = '
\ 15 |
\ 16 | Select example format\ 17 | \ 18 | \ 19 | \ 20 | \ 21 |
\ 22 |
'; 23 | 24 | var exhd = document.querySelectorAll('aside.ex-group > :first-child'); 25 | 26 | for (var j= 0; j < exhd.length; j++) { 27 | var placement = exhd[j].tagName.toLowerCase() === 'p' ? 'afterend' : 'beforebegin'; 28 | exhd[j].insertAdjacentHTML(placement, buttons); 29 | } 30 | } 31 | 32 | 33 | function formatExampleTitles() { 34 | // add the format labels 35 | var asidehd = document.querySelectorAll('aside.ex-group span.example-title'); 36 | var format_ext = ' expressed in JSON-LD'; 37 | 38 | for (var k = 0; k < asidehd.length; k++) { 39 | asidehd[k].insertAdjacentHTML('beforeEnd', format_ext); 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /common/js/permalink-a11y.js: -------------------------------------------------------------------------------- 1 | 2 | function updatePermaLinks() { 3 | 4 | var links = document.querySelectorAll('a[class~="self-link"]'); 5 | 6 | for (var i = 0; i < links.length; i++) { 7 | 8 | var secno = ''; 9 | var sectype = ''; 10 | 11 | var title = links[i].textContent.trim(); 12 | var parentElem = links[i].parentNode; 13 | 14 | if (title.match(/^WebIDL/)) { 15 | // permalink for idl 16 | // use link text for name 17 | secno = links[i].textContent; 18 | sectype = ''; 19 | } 20 | 21 | else if (title.match(/^Example/)) { 22 | // permalink for an example 23 | // number is inside the a tag with no class 24 | secno = links[i].querySelector('bdi'); 25 | if (secno == null) { 26 | console.log('Error creating new example permalink for :' + parent.textContent); 27 | continue; 28 | } 29 | secno = secno.textContent 30 | sectype = 'Example '; 31 | } 32 | 33 | else if (title.match(/^Permalink/)) { 34 | // ignore hidden definition permalinks 35 | continue; 36 | } 37 | 38 | else { 39 | // number for sections/appendixes is sibling of the a tag with secno class 40 | secno = parentElem.querySelector('.secno'); 41 | if (secno == null) { 42 | console.log('Error creating new section permalink for :' + parent.textContent); 43 | continue; 44 | } 45 | secno = secno.textContent 46 | // determine if section/appendix from parent class 47 | sectype = parentElem.parentNode.classList.contains('appendix') ? 'Appendix ' : 'Section '; 48 | } 49 | 50 | 51 | links[i].setAttribute('aria-label', 'Permalink for ' + sectype + secno); 52 | links[i].setAttribute('title', 'Permalink for ' + sectype + secno); 53 | } 54 | } 55 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Repository for the Schema.org Accessibility Properties for Content Discoverability 3 | 4 | This repository is where the vocabularies of terms are maintained for the following schema.org accessibility properties: 5 | 6 | - [accessibilityAPI](https://schema.org/accessibilityAPI) 7 | - [accessibilityControl](https://schema.org/accessibilityControl) 8 | - [accessibilityFeature](https://schema.org/accessibilityFeature) 9 | - [accessibilityHazard](https://schema.org/accessibilityHazard) 10 | - [accessibilitySummary](https://schema.org/accessibilitySummary) 11 | - [accessMode](https://schema.org/accessMode) 12 | - [accessModeSufficient](https://schema.org/accessModeSufficient) 13 | 14 | For more information about the original development of these properties, please refer to the [a11ymetadata.org web site](http://www.a11ymetadata.org/about/). 15 | 16 | ## Published Documents 17 | 18 | ### Vocabulary 19 | 20 | The Schema.org Accessibility Properties for Content Discoverability vocabulary is available in the following forms: 21 | 22 | - [Editor's Draft](https://w3c.github.io/a11y-discov-vocab/) - The editor's draft is the working version of the vocabulary. It may include changes that have not yet been published and that may be subject to further revision before publishing. This document has no standing and should not be referenced. 23 | - [Latest Version](https://www.w3.org/2021/a11y-discov-vocab/latest/) - The latest version of the vocabulary is the stable version of the vocabulary endorsed by the Community Group. The latest version should be referenced by implementers. 24 | 25 | ### Crosswalk 26 | 27 | The Community Group also maintains a crosswalk document that describes how to map the Schema.org properties and terms to equivalent expressions in EPUB and ONIX: 28 | 29 | - [Editor's Draft](https://w3c.github.io/a11y-discov-vocab/crosswalk) 30 | - [Latest Version](https://w3c.github.io/a11y-discov-vocab/latest/crosswalk/) 31 | 32 | ## Governance 33 | 34 | This repository is maintained by the [Accessibility Discoverability Vocabulary for Schema.org Community Group](https://www.w3.org/community/a11y-discov-vocab/). 35 | 36 | Please refer to the [Community Group's charter](https://github.com/w3c/a11y-discov-vocab/wiki/Community-Group-Charter) for a detailed description of the governance of this group. 37 | 38 | The chairs of the Community Group are responsible for ensuring the smooth functioning of the group and resolving any issues that might arise. 39 | 40 | The group is currently chaired by Charles Lapierre, Madeleine Rothberg and Matt Garrish. Please feel free to reach out to any of these individuals if you have concerns about the way the group is operating. 41 | 42 | ## Mode of Operation 43 | 44 | The Community Group anticipates using the GitHub tracker in this repository to discuss and resolve issues. 45 | 46 | The Community Group will endeavour to gain consensus on issues before resolving them, but complete consensus of all participants is not required in order to progress a resolution. 47 | 48 | The chairs may periodically request teleconferences to discuss items. For example, if consensus cannot be reached through the tracker, if there are proposals that require group discussion, or if the group determines there are new work items that cannot be initiated through the tracker. In these cases, the date of the meeting and agenda will be sent to the [Community Group's email list](https://lists.w3.org/Archives/Public/public-a11y-discov-vocab/) in advance of the call. Minutes for all meetings will be posted to the Community Group's home page. 49 | 50 | The Community Group may also hold meetings or get togethers at W3C events, such as TPAC. 51 | 52 | ## Participation 53 | 54 | It is not required to join the [Accessibility Discoverability Vocabulary for Schema.org Community Group](https://www.w3.org/community/a11y-discov-vocab/) in order to raise issues or engage in discussion in the tracker. Only a GitHub account is required. 55 | 56 | Individuals interested in this work are strongly encouraged to join the group, however, as only participants of the Community Group may engage in group teleconferences and other meetings. 57 | 58 | ## Contributing to the Repository 59 | 60 | Use the standard fork, branch, and pull request workflow to propose changes to the specification. Please make branch names informative by, for example, including the issue or bug number. 61 | 62 | Editorial changes that improve the readability of the vocabulary or correct spelling or grammatical mistakes are welcome. 63 | 64 | Please read [CONTRIBUTING.md](CONTRIBUTING.md), about licensing contributions. 65 | 66 | ## Publishing New Revisions 67 | 68 | Only chairs and editors may publish new versions of the vocabulary. 69 | 70 | The Community Group will endeavour to republish the vocabulary whenever consensus on proposed changes is reached and a pull request is ready to be integrated. 71 | 72 | Exceptions to this rule may occur at the chairs' discretion. For example, if multiple issues need to be resolved for a new version to make sense, or if many small issues are expected to be resolved within a short period of time, so the work of republishing for each is not warranted. 73 | 74 | ## Code of Ethics 75 | 76 | The Community Group operates under the W3C's [Code of Ethics and Professional Conduct](https://www.w3.org/Consortium/cepc/). 77 | -------------------------------------------------------------------------------- /crosswalk/indexOld.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Schema.org Accessibility Properties Crosswalk 6 | 7 | 8 | 9 | 50 | 93 | 94 | 95 |
96 |

This document crosswalks the accessibility metadata for Schema.org, EPUB, and ONIX.

97 |
98 |
99 |
100 |

EPUB and ONIX

101 | 102 |

The following table provides a crosswalk between the properties defined in the EPUB Accessibility specification [[EPUB-A11Y-11]] and The EPUB Accessibility exemption property [[EPUB-A11Y-Exemption]] and 105 | the equivalents defined in the ONIX metadata standard [[ONIX]].

106 | 107 |
108 |

The conformsTo term used in EPUB is drawn from Dublin 110 | Core.

111 |
112 | 113 |
114 |

Unless stated otherwise, all code values are from ONIX code list 196: E-publication Accessibility Details.

116 |
117 | 118 | 119 | 120 | 121 | 122 | 123 | 124 | 125 | 126 | 127 | 129 | 130 | 131 | 132 | 136 | 143 | 144 | 145 | 149 | 152 | 153 | 154 | 159 | 164 | 165 | 166 | 171 | 176 | 177 | 178 | 183 | 188 | 189 | 190 | 195 | 200 | 201 | 202 | 207 | 212 | 213 | 214 | 219 | 224 | 225 | 226 | 231 | 236 | 237 | 238 | 243 | 248 | 249 | 250 | 255 | 260 | 261 | 262 | 267 | 271 | 272 | 273 | 278 | 282 | 283 | 284 | 285 | 288 | 291 | 292 | 293 | 296 | 299 | 300 | 301 | 304 | 307 | 308 | 309 |
EPUBONIX

certifiedBy

Code 90: Compliance certification by (name)

133 |

certifierReport

135 | 		137 |

Code 94: Compliance web page for 138 | detailed accessibility information

139 |

or, if a publisher is self-certifying,

140 |

Code 96: Publisher's web page for 141 | detailed accessibility information

142 |
146 |

certifierCredential

148 | 		150 |

Code 93: Compliance certification by (URL)

151 |
155 |

dcterms:conformsTo with the text string
157 | EPUB Accessibility 1.1 - WCAG 2.0 Level A

158 | 		160 |

Code 04: EPUB Accessibility Specification 1.1

161 |

Code 80: WCAG v2.0

162 |

Code 84: WCAG level A

163 |
167 |

dcterms:conformsTo with the text string
169 | EPUB Accessibility 1.1 - WCAG 2.0 Level AA

170 | 		172 |

Code 04: EPUB Accessibility Specification 1.1

173 |

Code 80: WCAG v2.0

174 |

Code 85: WCAG level AA

175 |
179 |

dcterms:conformsTo with the text string
181 | EPUB Accessibility 1.1 - WCAG 2.0 Level AAA

182 | 		184 |

Code 04: EPUB Accessibility Specification 1.1

185 |

Code 80: WCAG v2.0

186 |

Code 86: WCAG level AAA

187 |
191 |

dcterms:conformsTo with the text string
193 | EPUB Accessibility 1.1 - WCAG 2.1 Level A

194 | 		196 |

Code 04: EPUB Accessibility Specification 1.1

197 |

Code 81: WCAG v2.1

198 |

Code 84: WCAG level A

199 |
203 |

dcterms:conformsTo with the text string
205 | EPUB Accessibility 1.1 - WCAG 2.1 Level AA

206 | 		208 |

Code 04: EPUB Accessibility Specification 1.1

209 |

Code 81: WCAG v2.1

210 |

Code 85: WCAG level AA

211 |
215 |

dcterms:conformsTo with the text string
217 | EPUB Accessibility 1.1 - WCAG 2.1 Level AAA

218 | 		220 |

Code 04: EPUB Accessibility Specification 1.1

221 |

Code 81: WCAG v2.1

222 |

Code 86: WCAG level AAA

223 |
227 |

dcterms:conformsTo with the text string
229 | EPUB Accessibility 1.1 - WCAG 2.2 Level A

230 | 		232 |

Code 04: EPUB Accessibility Specification 1.1

233 |

Code 82: WCAG v2.2

234 |

Code 84: WCAG level A

235 |
239 |

dcterms:conformsTo with the text string
241 | EPUB Accessibility 1.1 - WCAG 2.2 Level AA

242 | 		244 |

Code 04: EPUB Accessibility Specification 1.1

245 |

Code 82: WCAG v2.2

246 |

Code 85: WCAG level AA

247 |
251 |

dcterms:conformsTo with the text string
253 | EPUB Accessibility 1.1 - WCAG 2.1 Level AAA

254 | 		256 |

Code 04: EPUB Accessibility Specification 1.1

257 |

Code 82: WCAG v2.2

258 |

Code 86: WCAG level AAA

259 |
263 |

dcterms:conformsTo with the URL 265 | http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a

266 | 		268 |

Code 02: EPUB Accessibility 269 | Specification 1.0 A

270 |
274 |

dcterms:conformsTo with the URL 276 | http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa

277 | 		279 |

Code 03: EPUB Accessibility 280 | Specification 1.0 AA

281 |
286 |

a11y:exemption with the text string
eaa-microenterprise

287 | 		289 |

Code 75: EAA exception 1 - Micro-enterprises

290 |
294 |

a11y:exemption with the text string
eaa-disproportionate-burden

295 | 		297 |

Code 76: EAA exception 2 - Disproportionate burden

298 |
302 |

a11y:exemption with the text string
eaa-fundamental-alteration

303 | 		305 |

Code 77: EAA exception 3 - Fundamental modification

306 |
310 |
311 |
312 |

Schema.org and ONIX

313 | 314 |

The following table provides a crosswalk between the Schema.org metadata and ONIX standard [[ONIX]].

315 | 316 |
317 |

Unless stated otherwise, all code values are from ONIX code list 196: E-publication Accessibility Details.

319 |
320 | 321 | 322 | 323 | 324 | 325 | 326 | 327 | 328 | 329 | 330 | 331 | 332 | 333 | 335 | 337 | 338 | 339 | 341 | 343 | 344 | 345 | 347 | 348 | 349 | 350 | 351 | 353 | 354 | 355 | 356 | 358 | 359 | 360 | 361 | 363 | 369 | 370 | 371 | 372 | 375 | 376 | 377 | 379 | 382 | 383 | 384 | 385 | 388 | 389 | 390 | 392 | 397 | 398 | 399 | 401 | 402 | 403 | 404 | 406 | 407 | 408 | 409 | 411 | 412 | 413 | 414 | 416 | 419 | 420 | 421 | 423 | 424 | 425 | 426 | 428 | 431 | 432 | 433 | 435 | 440 | 441 | 442 | 444 | 449 | 450 | 451 | 453 | 455 | 456 | 457 | 458 | 460 | 466 | 467 | 468 | 470 | 473 | 474 | 475 | 477 | 479 | 480 | 481 | 482 | 484 | 485 | 486 | 487 | 489 | 492 | 493 | 498 | 502 | 503 | 504 | 506 | 507 | 508 | 509 | 511 | 514 | 515 | 516 | 518 | 519 | 520 | 521 | 523 | 525 | 526 | 527 | 529 | 530 | 531 | 532 | 534 | 538 | 539 | 540 | 542 | 546 | 547 | 548 | 550 | 552 | 553 | 554 | 556 | 557 | 558 | 559 | 561 | 562 | 563 | 564 | 566 | 567 | 568 | 569 | 571 | 573 | 574 | 575 | 577 | 583 | 584 | 585 | 587 | 588 | 589 | 590 | 592 | 594 | 595 | 596 | 598 | 599 | 600 | 601 | 603 | 604 | 605 | 606 | 608 | 609 | 610 | 611 | 612 | 615 | 616 | 617 | 618 | 621 | 622 | 623 | 624 | 627 | 628 | 629 | 630 | 633 | 634 | 635 | 636 | 639 | 640 | 641 | 642 | 643 | 644 | 645 | 646 | 647 | 649 | 651 | 652 | 653 | 655 | 657 | 658 | 659 | 661 | 663 | 664 | 665 | 667 | 668 | 669 | 670 | 672 | 674 | 675 | 676 | 678 | 680 | 681 | 682 | 684 | 686 | 687 | 688 | 690 | 691 | 692 | 693 | 694 | 695 | 696 | 697 | 698 | 699 | 700 | 701 | 702 | 703 | 704 | 705 | 706 | 707 | 708 | 709 | 710 | 711 | 712 | 713 | 714 | 715 | 716 | 717 | 718 | 719 | 720 | 721 | 722 | 723 | 724 | 725 | 726 | 727 | 728 | 729 | 730 | 731 | 733 | 747 | 748 | 749 | 751 | 756 | 757 | 758 | 760 | 762 | 763 | 764 | 766 | 767 | 768 | 769 | 771 | 776 | 777 | 778 | 780 | 782 | 783 | 784 | 786 | 788 | 789 | 790 | 792 | 793 | 794 | 795 | 797 | 799 | 800 | 801 | 803 | 811 | 812 | 813 | 815 | 832 | 833 | 834 | 835 | 836 | 837 | 838 | 839 | 840 | 842 | 843 | 844 | 846 | 854 | 855 | 856 | 858 | 859 | 860 | 861 | 863 | 865 | 866 | 867 | 869 | 870 | 871 | 872 | 873 | 874 | 875 | 876 | 877 | 881 | 899 | 900 | 901 | 902 |
Schema.orgONIX
accessibilityFeature

alternativeText

Code 14: Short alternative 336 | descriptions

annotations

List 21: Edition type, 342 | Code ANN: Annotated edition

ARIA

Code 30: ARIA roles provided

audioDescription

Code 28: Full alternative audio descriptions

bookmarks (deprecated)

–

braille

List 21: Edition type, Code BRL: Braille edition

365 |

or

366 |

List 175: Product form detail, Code E146: BRF(Braille-ready file) Electronic Braille file

368 |

captions (deprecated)

 373 |

–

374 |

ChemML

 380 |

Code 18: Accessible chem content

381 |

closedCaptions

 386 |

List 175: Product form detail, Code V210: Closed captions

387 |

describedMath

 393 |

Code 14: Short alternative textual descriptions

394 |

along with

395 |

List 81: Product content type, Code 48: Mathematical content

displayTransformability

Code 36: All textual content can be modified

fullRubyAnnotations

–

highContrastAudio

Code 27: Use of high contrast between foreground and background audio

highContrastDisplay

Code 26: Use of high contrast between text and background color

417 |

and

418 |

Code 37: Use of ultra-high contrast between text foreground and background

horizontalWriting

–

index

 429 |

Code 12: Index navigation

430 |

largePrint

List 21: Edition type, Code LTE: Large type / large print edition

437 |

and

438 |

List 21: Edition type, Code ULP: Ultra large print edition

latex

Code 35: Accessible math content (as LaTeX)

445 |

should be used with

446 |

List 81: Product content type, Code 48: Mathematical content

448 |

latex-chemistry

–

454 |

longDescription

 461 |

Code 15: Full alternative 462 | descriptions

463 |

Code 16: Visualised data also 464 | available as non-graphical data

465 |

MathML

 471 |

Code 17: Accessible math content

472 |

MathML-chemistry

Code 34: Accessible chemistry content (as MathML)

478 |

none

Code 09: Inaccessible, or known limited accessibility

openCaptions

 490 |

List 175: Product form detail, Code V211: Open captions

491 |
494 |

pageBreakMarkers
(formerly 496 | printPageNumbers)

497 | 		499 |

Code 19: Print-equivalent page 500 | numbering

501 |

pageNavigation

–

readingOrder

 512 |

Code 13: Reading order

513 |

rubyAnnotations

–

signLanguage

List 175: Product form detail, Code V213: Sign language interpretation

structuralNavigation

Code 29: Next / Previous structural navigation

sychronizedAudioText

 535 |

Code 20: Synchronised pre-recorded 536 | audio

537 |

tableOfContents

 543 |

Code 11: Table of contents 544 | navigation

545 |

taggedPDF

Code 05: PDF/UA

551 |

Code 06: PDF/UA-2

tactileGraphic

–

tactileObject

–

timingControl

–

transcript

List 175: Product form detail, Code V212: Transcript

ttsMarkup

 578 |

Code 21: Text-to-speech hinting 579 | provided

580 |

Code 22: Language tagging 581 | provided

582 |

unknown

Code 08: Unknown accessibility

unlocked

List 144: E-publication technical protection, Code 00: None

verticalWriting

–

withAdditionalWordSegmentation

–

withoutAdditionalWordSegmentation

–

–

 613 |

Code 31: Accessible controls provided

614 |

–

 619 |

Code 24: Dyslexia readability

620 |

–

 625 |

Code 32: Landmark navigation

626 |

–

 631 |

Code 10: No reading system accessibility options disabled

632 |

–

 637 |

Code 25: Use of color is not sole means of conveying information

638 |
accessibilityHazard

flashing

List 143: US CPSIA or other international hazard warning type, Code 13: WARNING – Flashing hazard

motionSimulation

List 143: US CPSIA or other international hazard warning type, Code 17: WARNING – Motion simulation hazard

sound

List 143: US CPSIA or other international hazard warning type, Code 15: WARNING – Sound hazard

none

List: 143; Code: 00 No known hazards or warnings

noFlashingHazard

List 143: US CPSIA or other international hazard warning type, Code 14: No flashing hazard warning necessary

noMotionSimulationHazard

List 143: US CPSIA or other international hazard warning type, Code 18: No motion simulation hazard warning necessary

noSoundHazard

List 143: US CPSIA or other international hazard warning type, Code 16: No sound hazard warning necessary

unknown

–

unknownFlashingHazard

List: 143; Code: 24 Flashing risk unknown

unknownMotionSimulationHazard

List: 143; Code: 26 Motion simulation unknown

unknownSoundHazard

List: 143; Code: 25 Sound risk unknown

accessibilityAPI
The metadata accessibilityAPI does not really apply to EPUBs directly but rather to the Reading System itself. Therefore we have not included it here in this crosswalk to ONIX.
accessibilityControl
The metadata accessibilityControl does not really apply to EPUBs directly but rather to the Reading System itself. Therefore we have not included it here in this crosswalk to ONIX.
accessMode

auditory

List 81: Product content type, 734 |

    735 |
  • Code 01: Audiobook
    • 737 |

    plus types of audio content

    738 |
  • Code 22: Additional audio content not part of main content
    • 739 |
  • Code 13: Other speech content
    • 740 |
  • Code 03: Music recording
    • 741 |
  • Code 04: Other audio
    • 742 |
  • Code 21: Partial performance – spoken word
    • 743 |
  • Code 23: Promotional audio for other book product
    • 744 | 745 |
746 |

chartOnVisual

 752 |

List 81: Product content type, Code 19: Figures, Diagrams, 754 | Charts

755 |

chemOnVisual

List 81: Product content type, Code 47: Chemical content

colorDependent

–

diagramOnVisual

 772 |

List 81: Product content type, Code 19: Figures, Diagrams, 774 | Charts

775 |

mathOnVisual

List 81: Product content type, Code 48: Mathematical content

musicOnVisual

List 81: Product content type, Code 11: Musical notation

tactile

–

textOnVisual

List 81: Product content type, Code 49: Images of text

textual

 804 |
    805 |
  • List 196: E-publication Accessibility Details, Code 52: All non-decorative content supports reading without sight
    • 807 |
  • List 81: Product content type, Code 10: Text
    • 809 |
810 |

visual

 816 |

List 81: Product content type,

817 |
    818 |
  • Code 07: Still images / graphics, 819 | or
    • 820 |
  • Code 18: Photographs, or
    • 821 |
  • Code 19: Figures, diagrams, 822 | charts, graphs, or
    • 823 |
  • Code 20: Additional images / graphics not part of main work, or
    • 824 |
  • Code 12: Maps and/or other 825 | cartographic content, or
    • 826 |
  • Code 46: Decorative images or graphics, or
    • 827 | 828 |
  • Code 50: Video content without audio, or
    • 829 |
  • Code 24: Animated / interactive illustrations
    • 830 |
831 |
accessModeSufficient
ONIX crosswalks are for instances where accessModeSufficient includes this 841 | vocabulary entry alone; combinations may occur but are more difficult to crosswalk

auditory

 847 |
    848 |
  • List 81: Product content type, Code 01: Audiobook
    • 850 |
  • List 196: E-publication Accessibility Details, Code 51: All non-decorative content supports reading via pre-recorded audio
    • 852 |
853 |

tactile

–

textual

List 196: E-publication Accessibility Details, Code 52: All non-decorative content supports reading without sight

visual

–

accessibilitySummary

accessibilitySummary

879 |

Human-readable text

880 | 		882 |
    883 |
  • Code 00: Accessibility summary
    • 884 |
  • Code 92: Accessibility addendum
    • 885 |
886 |

If present, include information from Codes:

887 |
    888 |
  • 95: Trusted intermediary's web 889 | page for detailed accessibility information
    • 890 |
  • 96: Publisher's web page for 891 | detailed accessibility information
    • 892 |
  • 98: Trusted Intermediary 893 | contact
    • 894 |
  • 99: Publisher contact for 895 | further accessibility information
    • 896 |
897 | 898 |
903 |
904 |
905 |

Acknowledgements

906 |

The editors would like to thank Christopher Saynor (Editeur) for his invaluable help reviewing this document.

907 |
908 | 909 | 910 | -------------------------------------------------------------------------------- /crosswalk/MARC-UNIMARC/Original-Crosswalk-Schema-ONIX-MARC21-UNIMARC.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Accessibility Properties Crosswalk (schema.org, ONIX, MARC21 & UNIMARC) 7 | 8 | 9 | 49 | 93 | 94 | 95 | 96 |
97 |

This document is a work in progress to extends the existing crosswalk for accessibility metadata for 98 | Schema.org, EPUB, and ONIX to MARC21 and UNIMARC.

99 |

It also adds a definition column.

100 |

Note : UNIMARC 231i (pdf file) offers a easy mapping to ONIX 196. Some references may be best described by other 102 | UNIMARC codes.

103 |
104 |
105 |

Information and references:

106 |

Schema definitions are found here: https://www.w3.org/2021/a11y-discov-vocab/latest/

107 |

“ConformsTo” term used in EPUB –drawn from Dublin Core.

108 |

MARC21 ressources

109 |

MARC 21 information

110 |

Fixed length fields (fixed fields) and variable length fields (very brief summary – fuller details)

111 |

MARC 21 fixed field = 3 digit numeric code (except the Leader); no indicators, value in each position has a specific meaning.

112 |

MARC 21 variable length field = 3 digit numeric code; each field can have 2 indicators that signify different values; each field can have one or more subfields; convention to designate subfield = $ ; if no subfield, assume $a.

113 |

More detailed information about MARC 21 field 341 and MARC21 field 532

114 |
115 | 116 |
117 | 118 |
119 |

From EPUB

120 | 121 |

The following table provides a crosswalk between the properties defined in the EPUB Accessibility specification [[EPUB-A11Y-11]] and the 123 | equivalents defined metadata standards [[ONIX]], MARC21, UNIMARC.

124 | 125 |

The conformsTo term used in EPUB is drawn from Dublin 127 | Core.

128 | 129 | 130 | 131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 | 140 | 141 | 142 | 144 | 145 | 151 | 152 | 153 | 154 | 155 | 156 | 159 | 160 | 164 | 171 | 172 | 173 | 174 | 175 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 191 | 193 | 194 | 195 | 196 | 197 | 198 | 199 | 205 | 207 | 208 | 209 | 210 | 211 | 212 |
DefinitionEPUBONIXEPUB to MARC21ONIX to MARC21UNIMARC
Identifies a party responsible for the testing and certification of the accessibility of an EPUB 143 | publication.certifiedByList 196: Code 93: Compliance certification 146 | by 147 | ProductFormFeatureDescription carries the URL of a web page belonging to the 148 | organisation responsible for compliance testing and certification of the product – typically a 149 | ‘home page’ or a page describing the certification scheme itself. For use in ONIX 3.0 only 150 | 532 8# Accessibility Note (Non-specific)532 8# Accessibility Note$a231 ##$i93$2onix196
f the evaluator provides a publicly-readable report of its assessment, provide a link to the 157 | assessment in an a11y:certifierReport property associated with [epub-3] the evaluator's 158 | name.. certifierReportList: 196; Code: 94: Compliance web page 161 | for detailed accessibility information or, if a publisher is self-certifying, Code: 96: 163 | Publisher's web page for detailed accessibility information 165 |
    166 |
  • 532 8# Accessibility Note (Non-specific)
    • 167 |
  • 856 - Electronic Location and Access
    • 168 |
  • 856 42 $3Certifier report$u[URL to Certifier report]
    • 169 |
170 | 		532 8# Accessibility Note$a231 ##$i94$2onix196 and/or 231 ##$i96$2onix196
Identifies a credential or badge that establishes the authority of the party identified in the 176 | associated certifiedBy property to certify content accessible.. certifierCredential–532 8# Accessibility Note (Non-specific)
An established standard to which the described resource conforms. 186 | dcterms:conformsTo 188 | with the URL 189 | http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-a 190 | List: 196; Code: 02: EPUB Accessibility 192 | Specification 1.0 A532 8# Accessibility Note (Non-specific)532 8# Accessibility Note$a231 ##$i02$2onix196
An established standard to which the described resource conforms. 200 | dcterms:conformsTo 202 | with the URL 203 | http://www.idpf.org/epub/a11y/accessibility-20170105.html#wcag-aa 204 | List: 196; Code: 03: EPUB Accessibility 206 | Specification 1.0 AA532 8# Accessibility Note (Non-specific)532 8# Accessibility Note$a231 ##$i03$2onix196
213 |
214 | 215 |
216 |

From Schema.org

217 | 218 |

The following table provides a crosswalk between the Schema.org metadata and [[ONIX]], MARC21, UNIMARC.

219 | 220 |

accessibilityFeature

221 |

ONIX: List 196 (specific codes follow)

222 |

MARC21: would not map. Mapping of individual properties is possible as reflected in the following table

223 |

UNIMARC: Easy mapping thru list 231 allowing reference to any ONIX list and code.

224 | 225 | 226 | 227 | 228 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 242 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 253 | 254 | 255 | 256 | 258 | 261 | 262 | 263 | 264 | 265 | 266 | 272 | 273 | 274 | 275 | 276 | 277 | 278 | 284 | 285 | 286 | 293 | 294 | 295 | 296 | 297 | 298 | 299 | 300 | 301 | 302 | 303 | 305 | 306 | 308 | 309 | 310 | 311 | 312 | 319 | 320 | 321 | 322 | 323 | 324 | 325 | 328 | 331 | 332 | 333 | 334 | 335 | 336 | 339 | 342 | 343 | 344 | 345 | 346 | 347 | 349 | 350 | 351 | 352 | 353 | 354 | 355 | 356 | 357 | 358 | 359 | 360 | 361 | 362 | 365 | 366 | 367 | 376 | 377 | 378 | 379 | 380 | 381 | 382 | 383 | 384 | 385 | 386 | 394 | 395 | 397 | 405 | 406 | 407 | 408 | 409 | 410 | 412 | 413 | 414 | 415 | 416 | 419 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 427 | 429 | 430 | 431 | 432 | 433 | 434 | 435 | 436 | 437 | 438 | 439 | 440 | 445 | 446 | 447 | 448 | 449 | 450 | 451 | 454 | 455 | 456 | 457 | 458 | 459 | 460 | 461 | 462 | 463 | 464 | 465 | 466 | 467 | 468 | 469 | 471 | 472 | 473 | 474 | 475 | 476 | 477 | 479 | 480 | 481 | 482 | 483 | 484 | 485 | 486 | 487 | 488 | 489 | 490 | 496 | 497 | 498 | 507 | 508 | 509 | 510 | 516 | 517 | 518 | 528 | 531 | 532 | 533 | 534 | 535 | 536 | 537 | 538 | 539 | 540 | 541 | 542 | 543 | 544 | 545 | 546 | 547 | 549 | 550 | 553 | 555 | 556 | 557 | 558 | 559 | 560 | 561 | 563 | 564 | 565 | 566 | 567 | 568 | 570 | 573 | 574 | 575 | 576 | 577 | 578 | 580 | 582 | 583 | 584 | 585 | 586 | 587 | 588 | 589 | 590 | 591 | 592 | 593 | 594 | 596 | 599 | 600 | 601 | 602 |
DefinitionSchema.orgONIXMARC21UNIMARC
Alternative text is provided for visual content (e.g., via the [HTML] alt attribute).alternativeText 241 | List: 196; Code: 14: Short alternative 243 | descriptions341 0# $avisual$balternativeText$2sapdv or 341 0# $aaudio$bcaptions$2sapdv231 ##$i14$2onix196
The work includes annotations from the author, instructor and/or others.annotations–341 0# $atextual$bannotations $2 sapdv or 532 8# $a This resource includes annotations from the 252 | author, instructor and/or others.
Audio descriptions are available (e.g., via an [HTML] track element with its kind attribute set 257 | to "descriptions").audioDescription 260 | –341 0# $avisual$daudioDescription$2sapdv
(deprecated). The work includes bookmarks to facilitate navigation to key points. 267 | Note: The use of the bookmarks value is now deprecated 268 | due to its ambiguity. For PDF bookmarks, the 269 | tableOfContents value should be used instead. For 270 | bookmarks in ebooks, the annotations value can be used. 271 | bookmarksN/A (Reading system feature)341 0# $atextual$bbookmarks$2sapdv
[1] The content is in braille format, or [2] alternatives are available in braille. 279 | Note: Information about the type of braille 280 | (e.g., ASCII, unicode, nemeth), whether the braille is 281 | contracted or not, and what code the braille conforms to 282 | should be provided in the accessibility summary. 283 | braille– 287 |
    288 |
  • Use Case [1] (the content is in Braille format) Not Applicable. Natively braille 289 | resources are described using a number of fields in MARC21.
    • 290 |
  • Use Case [2] (alternatives are available in Braille): 341 0# $atext$ebraille
    • 291 |
292 |
Indicates that synchronized captions are available for audio and video content.captions–341 0# $aauditory$bcaptions$2sapdv or 341 0# $avisual$bcaptions$2sapdv
Identifies that chemical information is encoded using the ChemML markup language.ChemMLList: 196; Code: 18: Accessible chem 307 | content341 0# $avisual$bChemML$2sapdv231 ##$i18$2onix196
Textual descriptions of math equations are included, whether in the alt attribute for 313 | image-based equations, using the alttext 315 | attribute for [MathML] 318 | equations, or by other means.describedMath–341 0# $avisual$bdescribedMath$2sapdv
Display properties are controllable by the user. This property can be set, for example, if 326 | custom CSS style sheets can be applied to the content to control the appearance. It can also be 327 | used to indicate that styling in document formats like Word and PDF can be modified.displayTransformability 330 | List: 175 ; Code: E200: Reflowable.341 0# $atextual$b displayTransformability$2sapdv231 ## $iE200$2onix175
Audio content with speech in the foreground meets the contrast thresholds set out in WCAG 338 | Success Criteria 1.4.7.highContrastAudio 341 | –3410$aauditory$dhighContrastAudio$2sapdv
Content meets the visual contrast threshold set out in WCAG Success 348 | Criteria 1.4.6.highContrastDisplay–3410#$atextual$b highContrastDisplay$2sapdv or 3410#$avisual$c highContrastDisplay$2sapd
The work includes an index to the content.indexList: 196; Code: 12: Index navigation3410#$atextual$bindex$2sapdv231 $i12$2onix196
The content has been formatted to meet large print guidelines. 363 | The property is not set if the font size can be increased. 364 | See displayTransformability.largePrint– 368 |
    369 |
  • 3410#$atextual$blargePrint$2sapdv
    • 370 |
  • 007 pos 00 Text pos 01Specific material designation b Large print
    • 371 |
  • 008 Books/Music pos 23 form of item d Large print
    • 372 |
  • 008 Cartographic Pos 29 d Large print
    • 373 |
  • 340 ## $nLarge print (18 point)$2rdafs
    • 374 |
375 |
Identifies that mathematical equations and formulas are encoded in the LaTeX typesetting system.latex–3410#$avisual$blatex$2sapdv
Descriptions are provided for image-based visual content 387 | and/or complex structures such as tables, mathematics, 388 | diagrams, and charts. 389 | Note: Authors may set this property independent of the 390 | method they use to provide the extended descriptions 391 | (i.e., it is not required to use the obsolete [HTML] 392 | longdesc attribute). 393 | longDescriptionList: 196; Code: 15: Full alternative 396 | descriptions; 16: Visualised data also available as non-graphical data 398 |
    399 |
  • 3410#$avisual$blongDescription$2sapdv
    • 400 |
  • 3410#$avisual$bDescribed video$2sapdv
    • 401 |
  • 3410#$aauditory$bcaptions$2sapdv
    • 402 |
  • 3410#$aauditory$btranscript$2sapdv
    • 403 |
404 | 		231 $i15$2onix196
Identifies that mathematical equations and formulas are encoded in [MathML].MathMLList: 196; Code: 17: Accessible math 411 | content3410#$avisual$bMathML$2sapdv231 $i17$2onix196
Indicates that the resource does not contain any accessibility features. 417 | The none value must not be set with any other feature value. 418 | none–No mapping
The work includes equivalent print page numbers. This setting is most commonly used with ebooks for which there is a print equivalent.printPageNumbersList: 196; Code: 19: Print-equivalent page 428 | numbering3410#$atextual$bprintPageNumbers$2sapdv231 $i19$2onix196
The reading order of the content is clearly defined in the markup (e.g., figures, sidebars and other secondary content has been marked up to allow it to be skipped automatically and/or manually escaped from.readingOrderList: 196; Code: 13: Reading order3410#$atextual$breadingOrder$2sapdv231 $i13$2onix196
Indicates that ruby annotations [HTML] are provided in the content. Ruby 441 | annotations are used as pronunciation guides for the logographic characters for languages 442 | like Chinese or Japanese. It makes difficult Kanji or CJK ideographic characters more 443 | accessible. The absence of rubyAnnotations implies that no CJK ideographic characters have 444 | ruby.rubyAnnotations–3410#$atextual$brubyAnnotations$2sapdv
Sign language interpretation is available for audio and video content. 452 | Note: Information about the sign language code used should be provided in the accessibility summary. 453 | signLanguage–3410#$aauditory$csignLanguage$2sapdv
The use of headings in the work fully and accurately reflects the document hierarchy, allowing navigation by assistive technologies.structuralNavigation–3410#$atextual$bstructuralNavigation$2sapdv
Describes a resource that offers both audio and text, with information that allows them to be rendered simultaneously. The granularity of the synchronization is not specified. This term is not recommended when the only material that is synchronized is the document headings.synchronizedAudioTextList: 196; Code: 20: Synchronised 470 | pre-recorded audio3410#$atextual$d sychronizedAudioText$2sapdv231 $i20$2onix196
The work includes a table of contents that provides links to the major sections of the content.tableOfContentsList: 196; Code: 11: Table of contents 478 | navigation3410#$atextual$btableofContents$2sapdv231 $i11$2onix196
The contents of the PDF have been tagged to permit access by assistive technologies.taggedPDF–3410#$atextual$btaggedPDF$2sapdv
491 |
    492 |
  • [1] When used with creative works such as books, indicates that the resource includes tactile graphics.
    • 493 |
  • [2] When used to describe an image resource or physical object, indicates that the resource is a tactile graphic.
    • 494 |
495 | 		tactileGraphic– 499 |
    500 |
  • Use case [1] (When used with creative works such as books, indicates that the resource 501 | includes tactile graphics): 3410#$avisual$etactileGraphic$2sapd
    • 502 |
  • Use case [2] (When used to describe an image resource or physical object, indicates that 503 | the resource is a tactile graphic): 500 - Note ; 500 $a Tactile graphic
    • 504 |
505 |

And 336 Content type ; 336 ##$atactile image$2rdacontent

506 |
511 |
    512 |
  • [1] When used with creative works such as books, indicates that the resource includes models to generate tactile 3D objects.
    • 513 |
  • [2] When used to describe a physical object, indicates that the resource is a tactile 3D object.
    • 514 |
515 | 		tactileObject– 519 |
    520 |
  • Use case [1] (When used with creative works such as books, indicates that the resource 521 | includes models to generate tactile 3D objects): 532 1# $aIncludes models to generate 3D 522 | objects
    • 523 |
  • Use case [2] (When used to describe a physical object, indicates that the resource is a 524 | tactile 3D object): Leader pos 6 r Three-dimensional artifact or naturally occurring 525 | object and 500 $aTactile 3D object.
    • 526 |
527 |

336 ##$atactile three-dimensional form$2rdacontent

 529 | 530 |
For content with timed interaction, this value indicates that the user can control the timing to meet their needs (e.g., pause and reset)timingControl–341$aauditory$dtimingControl$2sapdv or 341$avisual$dtimingControl$2sapdv
Indicates that a transcript of the audio content is available.transcript–341$aauditory$btranscript$2sapdv
One or more of [SSML], [Pronunciation-Lexicon], and [CSS3-Speech] properties has been 548 | used to enhance text-to-speech playback quality.ttsMarkupList: 196; Code: 21: Text-to-speech 551 | hinting provided; Code 22: Language tagging 552 | provided341$atext$bttsMarkup$2sapdv and 532 1# $a Text-to-speech has been optimised through provision of 554 | PLS lexicons, SSML or CSS Speech synthesis hints.231 $i21$2onix196 and/or 231 $i22$2onix196
No digital rights management or other content restriction protocols have been applied to the resource.unlocked–532 1# $aNo DRM (digital rights management) or other content restriction protocols have been 562 | applied to the resource.
ONIX: The language of the text has been specified (eg via the HTML or XML lang attribute) to optimise text-to-speech (and other alternative renderings), both at whole document level and, where appropriate, for individual words, phrases or passages in a different language.–List: 196; Code 22: Language tagging 569 | provided – helps with TTS in multi-lingual content532 1# $aThe language of the text has been specified (eg via the HTML or XML lang attribute) to 571 | optimise text-to-speech (and other alternative renderings), both at whole document level and, 572 | where appropriate,for individual words, phrases or passages in a different language.231 $i22$2onix196
ONIX: Specialised font, character and/or line spacing, justification and paragraph spacing, coloring and other options provided specifically to improve readability for dyslexic readers. Details, including the name of the font if relevant, should be listed in ProductFormFeatureDescription–List: 196; Code 24: Dyslexia readability 579 | 532 1# $aSpecialised font, character and line spacing, justification and paragraph spacing, and 581 | coloring for dyslexic readers.
ONIX: Known to lack significant features required for broad accessibility. For use in ONIX 3.0 only–List: 196; Code 09: Inaccessible532 2# $aLacks significant accessibility features.231 $i09$2onix196
ONIX: No accessibility features offered by the reading system, device or reading software (including but not limited to choice of text size or typeface, choice of text or background color, text-to-speech) are disabled, overridden or otherwise unusable with the product EXCEPT – in ONIX 3 messages only – those specifically noted as subject to restriction or prohibition in EpubUsageConstraint. Note that provision of any significant part of the textual content as images (ie as pictures of text, rather than as text, and without any textual equivalent) inevitably prevents use of these accessibility options.–List: 196; Code 10: No reading system 595 | accessibility options disabled (except)532 8# $aNo accessibility features offered by the reading system, device or reading software 597 | (including but not limited to choice of text size or typeface, choice of text or background 598 | color, text-to-speech) are disabled, overridden or otherwise unusable with the product.231 $i10$2onix196
603 | 604 |

accessibilityHazard

605 | 606 | 607 | 608 | 609 | 610 | 611 | 612 | 613 | 614 | 615 | 616 | 617 | 618 | 619 | 622 | 623 | 624 | 625 | 626 | 627 | 630 | 631 | 632 | 633 | 634 | 635 | 638 | 639 | 643 | 644 | 645 | 646 | 647 | 648 | 649 | 650 | 651 | 652 | 653 | 654 | 655 | 656 | 657 | 660 | 661 | 662 | 663 | 664 | 666 | 667 | 668 | 669 | 670 | 671 | 672 | 673 | 674 | 675 | 676 | 677 | 678 | 679 | 680 | 681 | 682 | 683 | 684 | 685 | 686 |
DefinitionSchema.orgONIXMARC21UNIMARC
Indicates that the resource presents a flashing hazard for photosensitive persons. This value should be set when the content meets the hazard thresholds described in Success Criterion 620 | 2.3.1 Three Flashes or Below Threshold [WCAG2]. 621 | flashing–532 8# $aThe resource presents a flashing hazard for photosensitive persons.
Indicates that the resource does not present a flashing hazard. This value should be set when the content conforms to Success Criterion 628 | 2.3.1 Three Flashes or Below Threshold [WCAG2]. 629 | noFlashingHazard–532 8# $aThis resource does not present a flashing hazard.
Indicates that the resource contains instances of motion simulation that may affect some individuals. 636 | Some examples of motion simulation include video games with a first-person perspective and CSS-controlled backgrounds that move when a user scrolls a page. 637 | motionSimulationList: 143; Code: 17 WARNING – Motion 640 | simulation hazard 641 | Products simulates (via visual effects) the experience of motion, which may cause nausea in 642 | sensitive people532 8# $aContains instances of motion simulation that may affect some individuals.231 $i17$2onix143
Indicates that the resource does not contain instances of motion simulation.noMotionSimulationHazard–532 8# $aThis resource does not contain instances of motion simulation.
Indicates that the resource contains auditory sounds that may affect some individuals. Editor's note: The application of this value is currently under discussion as its application is underspecified.soundList: 175; Code: A310: Sound effects 658 | Incidental sounds added to the audiobook narration (eg background environmental sounds). (may 659 | not correspond to a hazard)532 8# $aContains auditory sounds that may affect some individuals.231 $iA310$2onix175
Indicates that the resource does not contain auditory hazards. 665 | Editor's note: The application of this value is currently under discussion as its application is underspecified.noSoundHazard–532 8# $aThis resource does not contain auditory hazards.
Indicates that the resource does not contain any hazards.none–
Indicates that the author is not able to determine if the resource presents any hazards.unknown–532 8# $aThis resource has not been evaluated for hazard risks.
687 | 688 | 689 |

accessibilityAPI (Recommend Removal)

690 | 691 | 692 | 693 | 694 | 695 | 696 | 697 | 698 | 699 | 700 | 701 | 702 | 703 | 704 | 705 | 706 | 707 | 708 | 709 | 710 | 711 | 713 | 714 | 715 | 716 | 717 | 718 | 719 | 720 | 721 | 722 | 723 | 724 | 725 | 726 | 728 | 729 | 730 | 732 | 733 | 734 | 735 | 739 | 740 | 741 | 742 | 743 | 744 | 745 | 748 | 749 | 750 | 751 | 752 | 753 | 754 | 755 | 756 | 757 | 758 | 759 | 760 | 761 | 763 | 764 | 765 | 766 | 767 | 768 | 769 | 770 | 771 | 772 | 773 | 774 | 775 | 776 | 777 | 778 | 779 | 781 | 782 | 783 | 784 | 785 | 786 | 787 | 788 | 789 | 790 | 791 |
DefinitionSchema.orgONIXMARC21UNIMARC
Indicates the resource is compatible with the Android Access API.AndroidAccessibility–532 0# $aResource is compatible with the Android Accessibility API.
Indicates the resource includes ARIA roles to organize and improve the structure and navigation. The use of this value corresponds to the inclusion of Document Structure, 712 | Landmark, Live Region, and Window roles [WAI-ARIA].ARIA–
Indicates the resource is compatible with the Accessibility Toolkit (ATK) API [ATK] for GNOME.ATK–532 0# $aResource is compatible with the Accessibility Toolkit (ATK) API for GNOME
Indicates the resource is compatible with the Assistive Technology Service 727 | Provider Interface (AT-SPI) API [AT-SPI] for GNOME.AT-SPI–532 0# $a Indicates the resource is compatible with the Assistive Technology Service Provider 731 | Interface (AT-SPI) API for GNOME.
Indicates the resource is compatible with the BlackBerry Accessibility API. 736 | This value is now obsolete as BlackBerry devices phones and operating systems are no longer developed, sold, or maintained. 737 | Note: After 2016, the BlackBerry name was licensed for phones released using the Android platform. Compatibility with these devices must be indicated using the AndroidAccessibility value. 738 | BlackberryAccessibility (obsolete)–532 0# $aResource is compatible with the Blackberry Accessibility API.
Indicates the resource is compatible with the iAccessible2 API 746 | [IAccessible2] for Windows. 747 | iAccessible2–532 0# $aResource is compatible with the iAccessible2 API for Windows.
Authors should use the NSAccessibility value instead.iOSAccessibility (deprecated)–532 0# $aResource is compatible with the iAccessible2 API for Apple iOS devices.
Indicates the resource is compatible with the Java 762 | Accessibility API [JAPI].JavaAccessibility–532 0# $aResource is compatible with the Java Accessibility API (JAAPI).
Authors should use the UIAccessibility value instead.MacOSXAccessibility (deprecated)–532 0# $aResource is compatible with the iAccessible2 API for Windows.
Indicates the resource is compatible with the Microsoft Active Accessibility (MSAA) API [MSAA] for Windows.MSAA (Microsoft Active Accessibility)–532 0# $aResource is compatible with the Microsoft Active Accessibility (MSAA) API for Windows 780 |
Indicates the resource is compatible with the User Interface Automation API for Windows.UIAutomation–532 0# $aCompatible with the User Interface Automation API for Windows.
792 | 793 | 794 |

accessibilityControl (Recommend - Removal)

795 | 796 | 797 | 798 | 799 | 800 | 801 | 802 | 803 | 804 | 805 | 806 | 807 | 808 | 809 | 810 | 811 | 812 | 813 | 814 | 815 | 816 | 817 | 818 | 819 | 820 | 821 | 822 | 823 | 824 | 825 | 826 | 827 | 828 | 829 | 830 | 831 | 832 | 833 | 834 | 835 | 836 | 837 | 838 | 839 | 840 | 841 | 842 | 843 | 844 | 845 | 846 | 847 | 848 | 849 | 850 | 851 |
DefinitionSchema.orgONIXMARC21UNIMARC
Users can fully control the resource through keyboard input.fullKeyboardControl–532 0#$a Users can fully control the resource through keyboard input.
Users can fully control the resource through mouse input.fullMouseControl–532 0#$a Users can fully control the resource through mouse input.
Users can fully control the resource through switch input.fullSwitchControl–532 0#$a Users can fully control the resource through switch input.
Users can fully control the resource through touch input.fullTouchControl–532 0#$a Users can fully control the resource through touch input.
Users can fully control the resource through video input.fullVideoControl–532 0#$a Users can fully control the resource through video input.
Users can fully control the resource through voice input.fullVoiceControl–532 0#$a Users can fully control the resource through voice input.
852 | 853 |

accessMode

854 |
The human sensory perceptual system or cognitive faculty through which a person may process or 855 | perceive information.
856 | 857 | 858 | 859 | 860 | 861 | 862 | 863 | 864 | 865 | 866 | 867 | 868 | 869 | 872 | 873 | 874 | 879 | 880 | 881 | 882 | 883 | 884 | 886 | 887 | 888 | 889 | 890 | 891 | 892 | 893 | 894 | 895 | 896 | 897 | 898 | 899 | 900 | 902 | 903 | 904 | 905 | 906 | 907 | 909 | 910 | 911 | 912 | 913 | 914 | 915 | 916 | 918 | 919 | 920 | 921 | 922 | 923 | 924 | 926 | 927 | 928 | 929 | 930 | 931 | 932 | 933 | 934 | 935 | 936 | 937 | 938 | 939 | 941 | 942 | 943 | 944 | 947 | 948 | 962 | 963 | 964 | 965 | 966 | 968 | 969 | 972 | 985 | 986 | 987 |
DefinitionSchema.orgONIXMARC21UNIMARC
Indicates that the resource contains information encoded in auditory form. 870 | Note: This value is not set when the auditory content conveys no information. For example, an instructional video might include background music while all the necessary information to complete the task is conveyed visually and/or through text captions. 871 | auditory–341 0#$aauditory; Also: 875 | 336 ##$aperformed music$2rdacontent; 876 | 336 ##$asounds$2rdacontent; 877 | 336 ##$aspoken word$2rdacontent; 878 | 344 ## $i sound
Indicates that the resource contains charts encoded in visual form.chartOnVisualList: 81; Code 19: Figures, Diagrams, 885 | Charts341 0 $avisual; 532 8# $aResource contains charts encoded in visual form.231 $i19$2onix81
Indicates that the resource contains chemical equations encoded in visual form.chemOnVisual–341 0# $avisual; 532 8# $aResource contains chemical equations encoded in visual form.
Indicates that the resource contains information encoded such that color perception is necessary.colorDependent–532 2# $aThe resource contains information encoded in such that color perception is necessary. 901 |
Indicates that the resource contains diagrams encoded in visual form.diagramOnVisualList: 81; Code 19: Figures, Diagrams, 908 | Charts341 0# $avisual; 532 8# $a Resource contains diagrams encoded in visual form.231 $i19$2onix81
Indicates that the resource contains mathematical notations encoded in visual form.mathOnVisual–341 0# $avisual; 917 | 532 8# $aResource contains mathematical notations encoded in visual form.
Indicates that the resource contains musical notation encoded in visual form.musicOnVisual–341 0# $avisual; 925 | 532 8# $a Resource contains music encoded in visual form.
Indicates that the resource contains information encoded in tactile form. Note that although an indication of a tactile mode often indicates the content is encoded using a braille system, this is not always the case. Tactile perception may also indicate, for example, the use of tactile graphics to convey information.tactile–341 0#$atactile
Indicates that the resource contains text encoded in visual form.textOnVisual–341 0# $avisual; 940 | 532 8# $a Resource contains text encoded in visual form.
Indicates that the resource contains information encoded in textual form. 945 | Note: This value is not set if the only textual content is for navigational purposes. For example, an audiobook might include a table of contents, but it is not necessary to read the table of contents to read the work. Likewise, books with synchronized text-audio playback may only include headings to allow structured navigation. 946 | textualList: 81; Code: 10 combined with List: 196; Code: 10 means all text is 950 | actual text. Note that List: 81; Code: 10 on its own (without List: 196; Code: 10) admits 951 | the possibility that the "text" is inaccessible because it is an image of text. 952 |
Note : on this point ONIX is unclear. Codes 16 and 14 or 15 should also be mobilisedList: 196; Code: 09 Inaccessible 957 | Known to lack significant features required for broad accessibility. Would give a 958 | better indication for "Screen reader friendly" (if code 09 is not found so the publication is 959 | textual). In both cases it's hard for a publisher to figure out how to describe "all content is 960 | accessible thru true text", he must adopt a reasoning by absence. 961 | 		341 0# $atextual
Indicates that the resource contains information encoded in visual form. Note: This value is not set if the only visual imagery is presentational or not directly relevant to understanding the content. Examples of this type of imagery include cover images for publications, corporate logos, and purely decorative images. 967 | visualList: 81; Code: 07: Still images / graphics 970 | or Code: 18: Photographs or Code: 19: Figures, diagrams, charts, graphs or Code: 12: Maps 971 | and/or other cartographic content341 0# $avisual; Also: 973 |
    974 |
  • 336 ##$astill image$2rdacontent
    • 975 |
  • 336 ##$atwo-dimensional moving image$2rdacontent
    • 976 |
  • 336 ##$athree-dimensional moving image$2rdacontent
    • 977 |
  • 336 ##$acartographic image$2rdacontent
    • 978 |
  • 336$acartographic three-dimensional form$2rdacontent
    • 979 |
  • 336$acartographic moving image$2rdacontent
    • 980 |
  • 336$anotated movement$2rdacontent
    • 981 |
  • 336$anotated music$2rdacontent
    • 982 |
  • 336$aperformed movement$2rdacontent
    • 983 |
984 | 		231 $i07$2onix81
988 | 989 |

accessModeSufficient

990 |
A list of single or combined accessModes that are sufficient to understand all the intellectual content of a resource.
991 |

ONIX crosswalks are for instances where accessModeSufficient includes this vocabulary entry 992 | alone; combinations may occur but are more difficult to crosswalk

993 | 994 | 995 | 996 | 997 | 998 | 999 | 1000 | 1001 | 1002 | 1003 | 1004 | 1005 | 1006 | 1007 | 1008 | 1009 | 1010 | 1011 | 1012 | 1013 | 1014 | 1015 | 1016 | 1017 | 1018 | 1019 | 1020 | 1021 | 1022 | 1033 | 1034 | 1035 | 1036 | 1037 | 1038 | 1039 | 1040 | 1041 | 1042 | 1043 | 1044 |
DefinitionSchema.orgONIXMARC21UNIMARC
Indicates that auditory perception is necessary to consume the information.auditoryList: 81; Code:01341 0#$aauditory$2sapdv 181 #0 $cspw$2rdacontent (may correspond only to human narration)
Indicates that tactile perception is necessary to consume the information.tactile–341 0#$atactile$2sapdv
Indicates that the resource contains information encoded in textual form. Note: This value is not set if the only textual content is for navigational purposes.textualList: 81; Code: 10 combined with List: 196; Code: 10 means all text is 1024 | actual text. Note that List: 81; Code: 10 on its own (without List: 196; Code: 10) admits 1025 | the possibility that the "text" is inaccessible because it is an image of text. 1026 |
Note : on this point ONIX is unclear. List: 196; Code: 09 Inaccessible 1028 | Known to lack significant features required for broad accessibility. Would give a better 1029 | indication for "Screen reader friendly" (if code 09 is not found so the publication is textual). 1030 | In both cases it's hard for a publisher to figure out how to describe "all content is accesible 1031 | thru true text", he must adopt a reasoning by absence. 1032 | 		341 0#$atextual$2sapdv
Indicates that visual perception is necessary to consume the information.visual–341 0#$avisual$2sapdv
1045 | 1046 |

accessibilitySummary

1047 |
A human-readable summary of specific accessibility features or deficiencies, consistent with the other accessibility metadata but expressing subtleties such as "short descriptions are present but long descriptions will be needed for non-visual users" or "short descriptions are present and no long descriptions are needed." 1048 |
1049 | 1050 | 1051 | 1052 | 1053 | 1054 | 1055 | 1056 | 1057 | 1058 | 1059 | 1060 | 1061 | 1062 | 1063 | 1064 | 1067 | 1068 | 1069 | 1070 | 1071 | 1072 | 1073 | 1079 | 1080 | 1081 | 1082 | 1083 |
DefinitionSchema.orgONIXMARC21UNIMARC
The accessibilitySummary property is a free-form field that allows authors to describe the accessible properties of the resource. As a result, it does not have an associated vocabulary.accessibilitySummaryList: 196; Code: 00: 1065 | Accessibility 1066 | Summary532 8# $a [Text] 231 $i00$2onix196
Definition not foundHuman-readable textIf present, include information from List: 1074 | 196; Codes 95, 96, 98, and 99 (links for further information about 1078 | accessibility)Would not map
1084 |
1085 | 1086 | 1087 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Schema.org Accessibility Properties for Discoverability Vocabulary 6 | 7 | 8 | 9 | 10 | 69 | 70 | 71 |
72 |

This document defines the recommended vocabularies for use with the Schema.org accessibility properties 73 | for discoverability of creative works.

74 |
75 |
76 |
77 |

Introduction

78 | 79 |
80 |

Background

81 | 82 |

The CreativeWork type [[schema-org]] 83 | includes the following accessibility properties for discoverability:

84 | 85 | 94 | 95 |

Although schema.org contains many other properties that describe the accessibility of objects in its 96 | taxonomy, these specific properties were developed together as part of a project to improve the 97 | discoverability of accessible resources headed by Benetech and IMS Global. Many of these properties 98 | were derived directly from the IMS 100 | Global AccessForAll (AfA) Information Model Data Element Specification.

101 | 102 |

Part of this work included defining vocabularies of recommended values for use with these properties 103 | to ensure predictability for machine processing. This document represents those vocabularies.

104 | 105 |

By defining these vocabularies, not only is it simpler for authors to understand and apply the 106 | properties, but it ensures that search tools, user agents and other machine intelligence can easily 107 | parse and inform users of the information.

108 | 109 |
110 |

The vocabulary defined in this document is a continuation of the work that was informally hosted 111 | on the WebSchemas wiki (sometimes 112 | referred to as the "version 2.0 accessibility properties"). The project was moved to a W3C 113 | Community Group to better formalize the document and increase the transparency of its update 114 | process.

115 |

For more information about the original project, refer to the Accessibility Metadata Project's web site.

117 |
118 | 119 |

For more information on how to use schema.org accessibility properties not covered by 120 | this vocabulary, please refer to their relevant definitions in schema.org.

121 |
122 | 123 |
124 |

Vocabulary naming convention

125 | 126 |

The values defined in this vocabulary follow a camel casing convention: single words are lowercase, 127 | while compound words are concatenated into a single value with a capital letter indicating the start 128 | of each connected word (e.g., "alternativeText"). This convention is not applied to acronyms, 129 | accessibility APIs, and other values that already have recognized naming conventions (e.g., "MathML" 130 | and "iOSAccessibility").

131 | 132 |

Hyphens are used to add additional descriptors to the end of terms. These 133 | descriptors are only added to clarify certain ambiguities with terms and only one descriptor is 134 | allowed at the end of any given term. For example, languages like MathML and latex are typically 135 | associated with encoding math content but are sometimes used to encode chemical equations and 136 | formulas. To ensure users can differentiate when these languages are being used for chemistry, the 137 | "-chemistry" descriptor is defined in this vocabulary for use on the respective 138 | math terms.

139 | 140 |

To ensure maximum interoperability with user agents that process these properties, use the values 141 | exactly as they are defined in this vocabulary. Alternative case spellings may not be recognized 142 | (e.g., "mathml" or "aria").

143 | 144 |

If a user agent does not recognize a term with a descriptor, it should remove the hyphenated 145 | descriptor and attempt to process the base term.

146 | 147 |

User agent developers should be aware that these values may not be strictly validated depending on 148 | the context in which they are created and used. Two values that differ only in case should be 149 | treated as identical.

150 |
151 | 152 |
153 |

Extending the vocabulary

154 | 155 |

To extend terms with more information, this vocabulary used to recommend the old slash extension syntax employed by 157 | Schema.org until 2015. In this model, extensions of a term are made by adding a slash followed by a 158 | refinement term.

159 | 160 |

Authors are no longer recommended to use this extension mechanism, although the use of slashes is not 161 | formally deprecated for backwards compatibility with existing content. The slash syntax was poorly 162 | defined, especially when multiple refinements could be specified, making it difficult for machines 163 | to process.

164 | 165 |

When a user may require more information about the characteristics of a resource (e.g., the specifics 166 | of what type of braille it contains), it is better to explain these in 167 | human-readable terms in an accessibility summary.

168 | 169 |

If a term in this vocabulary is not be expressive enough, it is now recommended to open an issue in the tracker to consider how 171 | to improve the existing term (e.g., by renaming terms or defining more specialized cases).

172 | 173 |
174 |

Descriptors are not a general extensibility mechanism. If a term can 175 | benefit from a new descriptor, the resulting combined value must be registered in the 176 | vocabulary.

177 |
178 |
179 |
180 |
181 |

The accessibilityAPI property

182 | 183 |
184 |

Application

185 | 186 |
187 |

Indicates that the resource is compatible with the referenced accessibility API.

188 |
189 | 190 |

Compatibility with an accessibility API indicates that assistive technologies on the platform should 191 | be able to access the resource.

192 | 193 |

The property is not applicable to resources that are not tightly integrated with their user 194 | interface. It can describe whether a word processing document that only opens in a specific 195 | application will work on a given platform, for example, but is not a useful indicator of whether an 196 | HTML document will, as there are numerous user agents a user could use to render it.

197 | 198 |

Setting the property means that the resource is compatible with the given API(s). It does not 199 | necessarily mean that the content will be fully accessible to any given user group.

200 | 201 |

The expected value of the accessibilityAPI property is a list of the compatible APIs. 202 | For metadata formats incapable of expressing lists, the property should be repeated for each 203 | API.

204 | 205 | 262 |
263 | 264 |
265 |

Vocabulary

266 | 267 |
268 |

AndroidAccessibility

269 | 270 |

Indicates the resource is compatible with the Android Access API.

273 |
274 | 275 |
276 |

ARIA (deprecated)

277 | 278 |

Indicates the resource uses ARIA [[WAI-ARIA]] markup 279 | to improve interoperability with platform APIs.

280 | 281 |
282 |

The use of the ARIA value is now deprecated as ARIA is not an accessibility API. The 283 | accessibilityFeature property value "ARIA" is now recommended 284 | to use to indicate that a resource makes use of ARIA to improve structural navigation.

285 |
286 |
287 | 288 |
289 |

ATK

290 | 291 |

Indicates the resource is compatible with the Accessibility Toolkit (ATK) API [[ATK]] for GNOME.

293 |
294 | 295 |
296 |

AT-SPI

297 | 298 |

Indicates the resource is compatible with the Assistive Technology Service Provider 300 | Interface (AT-SPI) API [[AT-SPI]] for GNOME.

301 |
302 | 303 |
304 |

BlackberryAccessibility (obsolete)

305 | 306 |

Indicates the resource is compatible with the BlackBerry Accessibility API.

309 | 310 |

This value is now obsolete as BlackBerry devices phones and operating systems are no longer 311 | developed, sold, or maintained.

312 | 313 |
314 |

After 2016, the BlackBerry name was licensed for phones released using the Android platform. 315 | Compatibility with these devices must be indicated using the AndroidAccessibility value.

317 |
318 |
319 | 320 |
321 |

FuchsiaAccessibility

322 | 323 |

Indicates the resource is compatible with the Fuchsia Accessibility Framework.

326 |
327 | 328 |
329 |

iAccessible2

330 | 331 |

Indicates the resource is compatible with the iAccessible2 API 333 | [[IAccessible2]] for Windows.

334 |
335 | 336 |
337 |

iOSAccessibility (deprecated)

338 | 339 |

Authors should use the NSAccessibility value instead.

340 |
341 | 342 |
343 |

JavaAccessibility

344 | 345 |

Indicates the resource is compatible with the Java 347 | Accessibility API [[JAPI]].

348 |
349 | 350 |
351 |

MacOSXAccessibility (deprecated)

352 | 353 |

Authors should use the UIAccessibility value instead.

354 |
355 | 356 |
357 |

MSAA

358 | 359 |

Indicates the resource is compatible with the Microsoft Active Accessibility (MSAA) API [[MSAA]] for Windows.

362 |
363 | 364 |
365 |

NSAccessibility

366 | 367 |

Indicates the resource is compatible with the NSAccessibility 369 | API for Apple iOS and tvOS applications built on UIKit.

370 |
371 | 372 |
373 |

UIAccessibility

374 | 375 |

Indicates the resource is compatible with the UIAccessibility API for macOS applications built on AppKit.

378 |
379 | 380 |
381 |

UIAutomation

382 | 383 |

Indicates the resource is compatible with the User Interface Automation API for Windows.

386 |
387 |
388 |
389 |
390 |

The accessibilityControl property

391 | 392 |
393 |

Application

394 | 395 |
396 |

Identifies one or more input methods that allow access to all of the application 397 | functionality.

398 |
399 | 400 |

The accessibilityControl property is used to describe the ability of users to interact 401 | with the user interface controls that applications provide.

402 | 403 |

The property is not applicable to resources that are not tightly integrated with their user 404 | interface. It can describe whether users can control a word processing document that only opens in a 405 | specific application, for example, but is not a useful indicator of whether users can control an 406 | HTML document, as there are numerous user agent and assistive technology pairings a user could use 407 | to access it.

408 | 409 |

Setting the property means that the specified control method(s) are compatible with the resource.

410 | 411 |

The expected value of the accessibilityControl property is a list of the applicable 412 | control methods. For metadata formats incapable of expressing lists, the property should be repeated 413 | for each control method.

414 | 415 | 481 |
482 | 483 |
484 |

Vocabulary

485 | 486 |
487 |

fullKeyboardControl

488 | 489 |

Users can fully control the resource through keyboard input.

490 |
491 | 492 |
493 |

fullMouseControl

494 | 495 |

Users can fully control the resource through mouse input.

496 |
497 | 498 |
499 |

fullSwitchControl

500 | 501 |

Users can fully control the resource through switch input.

502 |
503 | 504 |
505 |

fullTouchControl

506 | 507 |

Users can fully control the resource through touch input.

508 |
509 | 510 |
511 |

fullVideoControl

512 | 513 |

Users can fully control the resource through video input.

514 |
515 | 516 |
517 |

fullVoiceControl

518 | 519 |

Users can fully control the resource through voice input.

520 |
521 |
522 |
523 |
524 |

The accessibilityFeature property

525 | 526 |
527 |

Application

528 | 529 |
530 |

Content features of the resource, such as accessible media, alternatives and supported 531 | enhancements for accessibility.

532 |
533 | 534 |

The accessibilityFeature property provides a list of all the applicable accessibility 535 | characteristics of the content. It allows a user agent to discover these characteristics without 536 | having to parse or interpret the structure of the content.

537 | 538 |

For ease of reading, this section splits the vocabulary into the following distinct groups:

539 | 540 | 569 | 570 |

The vocabulary also includes the term "none" that authors 571 | can set to indicate that the resource does not contain special enhancements. Similarly, the term 572 | "unknown" exists as a placeholder for marking content that authors need to 573 | review.

574 | 575 |

The expected value of the accessibilityFeature property is a list of the applicable 576 | features. For metadata formats incapable of expressing lists, the property should be repeated for 577 | each feature.

578 | 579 | 690 |
691 | 692 |
693 |

Vocabulary

694 | 695 |
696 |

Structure and navigation terms

697 | 698 |

The structure and navigation term identify structuring and navigation aids that facilitate use of 699 | a resource.

700 | 701 |
702 |
annotations (deprecated)
703 | 704 |

The resource includes annotations from the author, instructor and/or others.

705 | 706 |
707 |

The use of the annotations value is now deprecated due to the general nature 708 | of annotations in published works. When authors or publishers add annotations to a work, 709 | they provide information for all readers; they are not used as a means of enhancing 710 | otherwise inaccessible content.

711 |
712 |
713 | 714 |
715 |
ARIA
716 | 717 |

Indicates the resource includes ARIA roles to organize and improve the structure and 718 | navigation.

719 | 720 |

The use of this value corresponds to the inclusion of Document Structure, 722 | Landmark, Live Region, and Window roles [[WAI-ARIA]].

725 | 726 |
727 |

The accessibilityControl property can be 728 | used to indicate what input devices custom controls are accessible with.

729 |
730 |
731 | 732 |
733 |
bookmarks (deprecated)
734 | 735 |

The work includes bookmarks to facilitate navigation to key points.

736 | 737 |
738 |

The use of the bookmarks value is now deprecated due to its ambiguity. For 739 | PDF bookmarks, the tableOfContents value 740 | should be used instead.

741 |
742 |
743 | 744 |
745 |
index
746 | 747 |

The resource includes an index to the content.

748 |
749 | 750 |
751 |
pageBreakMarkers
752 |

(Formerly printPageNumbers.)

753 | 754 |

The resource includes static page markers, such as those identified by the doc-pagebreak 756 | role [[DPUB-ARIA-1.0]].

757 | 758 |

This value is most commonly used with ebooks for which there is a statically paginated 759 | equivalent, such as a print edition, but it is not required that the page markers correspond 760 | to another work. The markers may exist solely to facilitate navigation in purely digital 761 | works.

762 | 763 |
764 |

The value printPageNumbers is considered a synonym of 765 | pageBreakMarkers. Although its use is not formally deprecated, authors 766 | are strongly encouraged to use the more general pageBreakMarkers. Whether 767 | the markers correspond to a statically paginated alternative can be indicated through 768 | other metadata, such as a dc:source declaration.

769 |
770 |
771 | 772 | 782 | 783 |
784 |
readingOrder
785 | 786 |

The reading order of the content is clearly defined in the markup (e.g., figures, sidebars 787 | and other secondary content has been marked up to allow it to be skipped automatically 788 | and/or manually escaped from.

789 |
790 | 791 |
792 |
structuralNavigation
793 | 794 |

The use of headings in the resource fully and accurately reflects the document hierarchy, 795 | allowing navigation by assistive technologies.

796 |
797 | 798 |
799 |
tableOfContents
800 | 801 |

The resource includes a table of contents that provides links to the major sections of the 802 | content.

803 |
804 | 805 |
806 |
taggedPDF
807 | 808 |

The contents of the PDF have been tagged to permit access by assistive technologies.

809 | 810 |

Only set this value for PDFs whose tagging conforms to the PDF/UA standard [[iso-14289-1]] 811 | [[iso-14289-2]].

812 | 813 |
814 |

For more information about PDF tagging best practices, refer to Well-Tagged PDF (WTPDF).

816 |
817 |
818 |
819 | 820 |
821 |

Adaptation terms

822 | 823 |

The adaptation terms identify provisions in the content that enable reading in alternative access 824 | modes.

825 | 826 |
827 |
alternativeText
828 | 829 |

Alternative text is provided for visual content (e.g., via the [[HTML]] alt attribute).

832 |
833 | 834 |
835 |
audioDescription
836 | 837 |

Audio descriptions are available (e.g., via an [[HTML]] track element with its kind attribute set to 840 | "descriptions").

841 |
842 | 843 |
844 |
captions (deprecated)
845 | 846 |

Indicates that synchronized captions are available for audio and video content.

847 | 848 |
849 |

The use of the captions value is now deprecated. Authors should use the more 850 | specific closedCaptions or openCaptions values, as appropriate.

852 |
853 |
854 | 855 |
856 |
closedCaptions
857 | 858 |

Indicates that synchronized closed captions are available for audio and video content.

859 | 860 |

Closed captions are defined separately from the video, allowing users to control whether they 861 | are rendered or not, unlike open captions.

862 |
863 | 864 |
865 |
describedMath
866 | 867 |

Textual descriptions of math equations are included, whether in the alt attribute for 868 | image-based equations, using the alttext attribute for [[MathML]] equations, or by other means.

871 |
872 | 873 |
874 |
longDescription
875 | 876 |

Descriptions are provided for image-based visual content and/or complex structures such as 877 | tables, mathematics, diagrams, and charts.

878 | 879 |
880 |

Authors may set this property independent of the method they use to provide the extended 881 | descriptions (i.e., it is not required to use the obsolete [[HTML]] longdesc attribute).

884 |
885 |
886 | 887 |
888 |
openCaptions
889 | 890 |

Indicates that synchronized open captions are available for audio and video content.

891 | 892 |

Open captions are part of the video stream and cannot be turned off by the user, unlike closed captions.

894 |
895 | 896 |
897 |
signLanguage
898 | 899 |

Sign language interpretation is available for audio and video content.

900 | 901 | 902 |
903 |

Information about the sign language code used should be provided in the accessibility summary.

905 |
906 |
907 | 908 |
909 |
transcript
910 | 911 |

Indicates that a transcript of the audio content is available.

912 |
913 |
914 | 915 |
916 |

Rendering control terms

917 | 918 |

The rendering control values identify that access to a resource and rendering and playback of its 919 | content can be controlled for easier reading.

920 | 921 |
922 |
displayTransformability
923 | 924 |

Indicates that the display properties of the content are controllable by the user.

925 | 926 |

When setting this property, the author must ensure that the following are modifiable (when 927 | applicable to their language and writing mode):

928 | 929 |
    930 |
  • the text foreground and background colors
    • 931 |
  • the font family and size
    • 932 |
  • the paragraph spacing
    • 933 |
  • the text margin
    • 934 |
  • the line height
    • 935 |
  • the letter and word spacing
    • 936 |
  • the text alignment
    • 937 |
  • the writing direction (horizontal or vertical)
    • 938 |
  • the display of ruby (both visibility and text color)
    • 939 |
  • the inclusion of space characters as word separators
    • 940 |
941 | 942 |
943 |

The preceding list may not capture all needed display transformability characteristics 944 | for all languages. In such cases, authors must ensure the missing characteristics are 945 | also transformable when setting this metadata. To request an addition to the list, 946 | please open an issue in the 947 | vocabulary tracker.

948 |
949 | 950 |

In addition, text must not be represented as images unless it falls under the exceptions of 951 | Success Criterion 1.4.5 952 | [[WCAG2]].

953 | 954 |

Note that setting this property does not mean that users will be able to control all the 955 | properties of the display in all user agents. It only indicates that the author has not 956 | limited the ability of users to change the settings (e.g., by using style 957 | attributes [[HTML]] or !important declarations [[css-cascade-4]] that prevent 958 | user agents from altering the properties, or by restricting users from modifying Word or PDF 959 | files).

960 | 961 |

The property must not be set for content for which no user agents are available that can 962 | transform the appearance and presentation of the text.

963 |
964 | 965 |
966 |
synchronizedAudioText
967 | 968 |

Describes a resource that offers both audio and text, with information that allows them to be 969 | rendered simultaneously. The granularity of the synchronization is not specified. This term 970 | is not recommended when the only material that is synchronized is the document headings.

971 |
972 | 973 |
974 |
timingControl
975 | 976 |

For content with timed interaction, this value indicates that the user can control the timing 977 | to meet their needs (e.g., pause and reset)

978 |
979 | 980 |
981 |
unlocked
982 | 983 |

No digital rights management or other content restriction protocols have been applied to the 984 | resource.

985 |
986 |
987 | 988 |
989 |

Specialized markup terms

990 | 991 |

The specialized markup terms identify content available in specialized markup grammars. These 992 | grammars typically provide users with enhanced structure and navigation capabilities.

993 | 994 |
995 |
ChemML
996 | 997 |

Identifies that chemical information is encoded using the ChemML markup language.

999 |
1000 | 1001 |
1002 |
latex
1003 | 1004 |

Identifies that mathematical equations and formulas are encoded in the LaTeX typesetting system.

1006 |
1007 | 1008 |
1009 |
latex-chemistry
1010 | 1011 |

Identifies that the LaTeX typesetting system is 1012 | used to encode chemical equations and formulas.

1013 |
1014 | 1015 |
1016 |
MathML
1017 | 1018 |

Identifies that mathematical equations and formulas are encoded in [[MathML]].

1019 |
1020 | 1021 |
1022 |
MathML-chemistry
1023 | 1024 |

Identifies that [[MathML]] is used to encode chemical equations and formulas.

1025 |
1026 | 1027 |
1028 |
ttsMarkup
1029 | 1030 |

One or more of [[SSML]], [[Pronunciation-Lexicon]], and [[CSS3-Speech]] properties has been 1031 | used to enhance text-to-speech playback quality.

1032 |
1033 |
1034 | 1035 |
1036 |

Clarity terms

1037 | 1038 |

The clarity terms identify ways that the content has been enhanced for improved auditory or 1039 | visual clarity.

1040 | 1041 |
1042 |
highContrastAudio
1043 | 1044 |

Audio content with speech in the foreground meets the contrast thresholds set out in WCAG 1046 | Success Criteria 1.4.7 [[WCAG2]].

1047 | 1048 |
1049 |

Information about the how the audio meets the requirement should be provided in the accessibility summary (i.e., there is no background 1051 | noise, at least 20db difference between foreground speech and background noise, or the 1052 | background noise can be turned off.)

1053 |
1054 |
1055 | 1056 |
1057 |
highContrastDisplay
1058 | 1059 |

Content meets the visual contrast threshold set out in WCAG Success 1061 | Criteria 1.4.6 [[WCAG2]].

1062 |
1063 | 1064 |
1065 |
largePrint
1066 | 1067 |

The content has been formatted to meet large print guidelines.

1068 | 1069 |

The property is not set if the font size can be increased. See displayTransformability.

1071 | 1072 |
1073 |

Information about the type of large print (e.g., the font size) should be provided in the 1074 | accessibility summary.

1075 |
1076 |
1077 |
1078 | 1079 |
1080 |

Tactile terms

1081 | 1082 |

The tactile terms identify content that is available in tactile form.

1083 | 1084 |
1085 |
braille
1086 | 1087 |

The content is in braille format, or alternatives are available in braille.

1088 | 1089 | 1090 |
1091 |

Information about the type of braille (e.g., ASCII, unicode, nemeth), whether the braille 1092 | is contracted or not, and what code the braille conforms to should be provided in the accessibility summary.

1094 |
1095 |
1096 | 1097 |
1098 |
tactileGraphic
1099 | 1100 |

When used with creative works such as books, indicates that the resource includes tactile 1101 | graphics.

1102 | 1103 |

When used to describe an image resource or physical object, indicates that the resource is a 1104 | tactile graphic.

1105 | 1106 |
1107 |

Refer to the BANA Guidelines and Standards 1108 | for Tactile Graphics for more information about tactile graphic formats and 1109 | formatting.

1110 |
1111 |
1112 | 1113 |
1114 |
tactileObject
1115 | 1116 |

When used with creative works such as books, indicates that the resource includes models to 1117 | generate tactile 3D objects.

1118 | 1119 |

When used to describe a physical object, indicates that the resource is a tactile 3D 1120 | object.

1121 |
1122 |
1123 | 1124 |
1125 |

Internationalization terms

1126 | 1127 |

The internationalization terms identify those accessibility characteristics of the content which 1128 | are required for internationalization.

1129 | 1130 |
1131 |
fullRubyAnnotations
1132 | 1133 |

Indicates that ruby annotations 1134 | [[JLreq]] are attached to every CJK ideographic character in the content. Ruby annotations 1135 | are used as pronunciation guides for the logographic characters for languages like Chinese 1136 | or Japanese. They make difficult CJK ideographic characters more accessible.

1137 | 1138 |

If some but not all CJK ideographic characters have ruby annotations, use the rubyAnnotations value.

1140 |
1141 | 1142 |
1143 |
horizontalWriting
1144 | 1145 |

Indicates that the content can be laid out horizontally (e.g, using the 1146 | horizontal-tb writing mode of [[css-writing-modes-3]]). This value should 1147 | only be set when the language of the content allows both horizontal and vertical directions. 1148 | Notable examples of such languages are Chinese, Japanese, and Korean.

1149 | 1150 |
1151 |

Some dyslexic Japanese can read horizontal writing but cannot read vertical writing.

1152 |
1153 |
1154 | 1155 |
1156 |
rubyAnnotations
1157 | 1158 |

Indicates that ruby annotations are 1159 | attached to some but not all CJK ideographic characters in the content.

1160 | 1161 |

If all CJK ideographic characters have ruby annotations, use the fullRubyAnnotations value.

1163 |
1164 | 1165 |
1166 |
verticalWriting
1167 | 1168 |

Indicates that the content can be laid out vertically (e.g, using the 1169 | vertical-rl of [[css-writing-modes-3]]). This value should only be set when 1170 | the language of the content allows both horizontal and vertical directions.

1171 |
1172 | 1173 | 1174 |
1175 |
withAdditionalWordSegmentation
1176 | 1177 |

Indicates that the content can be rendered with additional word segmentation.

1178 | 1179 |
1180 |

Although the space character is not typically used for word segmentation in languages 1181 | such as Chinese, Japanese, Thai and Lao, it may be used for accessibility reasons.

1182 |
1183 |
1184 | 1185 |
1186 |
withoutAdditionalWordSegmentation
1187 | 1188 |

Indicates that the content can be rendered without additional word segmentation.

1189 |
1190 |
1191 | 1192 |
1193 |
none
1194 | 1195 |

Indicates that the resource does not contain any accessibility features.

1196 | 1197 |

The none value must not be set with any other feature value.

1198 |
1199 | 1200 |
1201 |
unknown
1202 | 1203 |

Indicates that the author has not yet checked if the resource contains accessibility features. 1204 | This value is only intended as a placeholder until an accessibility review can be completed.

1205 | 1206 |

The unknown value must not be set with any other feature value.

1207 |
1208 |
1209 |
1210 |
1211 |

The accessibilityHazard property

1212 | 1213 |
1214 |

Application

1215 | 1216 |
1217 |

A characteristic of the described resource that is physiologically dangerous to some users. 1218 | Related to WCAG 2.0 guideline 1219 | 2.3.

1220 |
1221 | 1222 |

Identifying potential hazards that a resource poses allows users to determine if a resource poses a 1223 | risk to them and to potentially filter out content that could be harmful.

1224 | 1225 |

The expected value of the accessibilityHazard property is a list of the applicable 1226 | hazards. For metadata formats incapable of expressing lists, the property should be repeated for 1227 | each hazard.

1228 | 1229 |

The accessibilityHazard property currently allows three types of hazards to be 1230 | identified: flashing, motion simulation, and sound. These correspond to the values 1231 | flashing, motionSimulation, and sound.

1232 | 1233 |

It also allows authors to indicate that each of the hazards is not present. In this case, the values 1234 | follow the pattern "no…Hazard", using the hazard names in place of the ellipsis 1235 | (e.g., noFlashingHazard).

1236 | 1237 |

If the author is sure there are no hazards, they are recommended to use the value "none" 1238 | in place of specifying that each individual hazard is not present. When setting this value, no other 1239 | hazard statuses are allowed.

1240 | 1241 |

Authors can additionally indicate that they are unable to determine if a hazard is present. In this 1242 | case, the values follow the pattern "unknown…Hazard", using the hazard names in 1243 | place of the ellipsis (e.g., unknownSoundHazard).

1244 | 1245 |

Authors can set the value unknown if they are unsure whether any hazards are present 1246 | (e.g., because they do not know how, or are unable, to assess them). When setting this value, no 1247 | other hazard statuses are allowed.

1248 | 1249 | 1308 | 1309 | 1385 | 1386 | 1438 |
1439 | 1440 |
1441 |

Vocabulary

1442 | 1443 |
1444 |

Hazard terms

1445 | 1446 |
1447 |
flashing
1448 | 1449 |

Indicates that the resource presents a flashing hazard for photosensitive persons.

1450 | 1451 |

This value should be set when the content meets the hazard thresholds described in Success Criterion 1453 | 2.3.1 Three Flashes or Below Threshold [[WCAG2]].

1454 | 1455 |

The flashing value must not be set when any of the noFlashingHazard, unknownFlashingHazard, none, or unknown values is 1459 | set.

1460 |
1461 | 1462 |
1463 |
motionSimulation
1464 | 1465 |

Indicates that the resource contains instances of motion simulation that may affect some 1466 | individuals.

1467 | 1468 |

Some examples of motion simulation include video games with a first-person perspective and 1469 | CSS-controlled backgrounds that move when a user scrolls a page.

1470 | 1471 |

The motionSimulation value must not be set when any of the noMotionSimulationHazard, unknownMotionSimulationHazard, none, or unknown values is set.

1476 |
1477 | 1478 |
1479 |
sound
1480 | 1481 |

Indicates that the resource contains auditory sounds that may affect some individuals.

1482 | 1483 |

The application of this value is currently under discussion as its application 1484 | is underspecified.

1485 | 1486 |

The sound value must not be set when any of the noSoundHazard, unknownSoundHazard, none, 1489 | or unknown values are set.

1490 |
1491 |
1492 | 1493 |
1494 |

No hazard terms

1495 | 1496 |
1497 |
none
1498 | 1499 |

Indicates that the resource does not contain any hazards.

1500 | 1501 |

It is recommended to use the none value when there are no hazards instead of 1502 | individual statements for noSoundHazard, noMotionSimulationHazard, and noFlashingHazard.

1505 | 1506 |

The none value must not be set when specifying either a known hazard or the unknown value. It should not be set when 1508 | negative hazard claims are made.

1509 |
1510 | 1511 |
1512 |
noFlashingHazard
1513 | 1514 |

Indicates that the resource does not present a flashing hazard.

1515 | 1516 |

The noFlashingHazard value must not be set when any of the flashing, unknownFlashing, or unknown values is set.

1520 | 1521 |

It should not be set when the none value is set.

1522 |
1523 | 1524 |
1525 |
noMotionSimulationHazard
1526 | 1527 |

Indicates that the resource does not contain instances of motion simulation.

1528 | 1529 |

The noMotionSimulation value must not be set when any of the motionSimulation, unknownMotionSimulationHazard, or 1532 | unknown values is set.

1533 | 1534 |

It should not be set when the none value is set.

1535 |
1536 | 1537 |
1538 |
noSoundHazard
1539 | 1540 |

Indicates that the resource does not contain auditory hazards.

1541 | 1542 |

The application of this value is currently under discussion as its application 1543 | is underspecified.

1544 | 1545 |

The noSoundHazard value must not be set when either of the sound, unknownSoundHazard, or unknown values is set.

1549 | 1550 |

It should not be set when the none value is set.

1551 |
1552 |
1553 | 1554 |
1555 |

Unknown hazard terms

1556 | 1557 |
1558 |
unknown
1559 | 1560 |

Indicates that the author is not able to determine if the resource presents any hazards.

1561 | 1562 |

It is recommended to use the unknown value when all hazards are unknown instead 1563 | of individual statements for unknownSoundHazard, unknownMotionSimulationHazard, and unknownFlashingHazard.

1567 | 1568 |

The unknown value must not be set when specifying either a known hazard or the 1569 | none value. It should not be set with the 1570 | individual unknown hazard value.

1571 |
1572 | 1573 |
1574 |
unknownFlashingHazard
1575 | 1576 |

Indicates that the author cannot determine if a flashing hazard exists.

1577 | 1578 |

The unknownFlashingHazard value must not be set when any of the flashing, noFlashingHazard, none 1581 | values is set.

1582 | 1583 |

It should not be set when the unknown value is 1584 | set.

1585 |
1586 | 1587 |
1588 |
unknownMotionSimulationHazard
1589 | 1590 |

Indicates that it is unknown if a motion simulation hazard exists within the content.

1591 | 1592 |

The unknownMotionSimulation value must not be set when any of the motionSimulation, noMotionSimulationHazard or none values is set.

1596 | 1597 |

It should not be set when the unknown value is 1598 | set.

1599 |
1600 | 1601 |
1602 |
unknownSoundHazard
1603 | 1604 |

Indicates that it is unknown if an auditory hazard exists within the content.

1605 | 1606 |

The unknownSoundHazard value must not be set when either of the sound, unknownSoundHazard, or unknown values is set.

1610 | 1611 |

It should not be set when the none value is set.

1612 |
1613 |
1614 |
1615 |
1616 |
1617 |

The accessibilitySummary property

1618 | 1619 |
1620 |

A human-readable summary of specific accessibility features or deficiencies, consistent with the 1621 | other accessibility metadata but expressing subtleties such as "short descriptions are present but 1622 | long descriptions will be needed for non-visual users" or "short descriptions are present and no 1623 | long descriptions are needed."

1624 |
1625 | 1626 |

The accessibilitySummary property is a free-form field that allows authors to describe the 1627 | accessible properties of the resource. As a result, it does not have an associated vocabulary.

1628 | 1629 | 1689 |
1690 |
1691 |

The accessMode property

1692 | 1693 |
1694 |

Application

1695 | 1696 |
1697 |

The human sensory perceptual system or cognitive faculty through which a person may process or 1698 | perceive information.

1699 |
1700 | 1701 |

The accessMode property describes the ways information is encoded in the resource, where 1702 | information is defined as any content that contributes to the understanding of the resource.

1703 | 1704 |

The expected value of the accessMode property is a list of the applicable access modes. 1705 | For metadata formats incapable of expressing lists, the property should be repeated for each access 1706 | mode.

1707 | 1708 |
1709 |

The access modes do not tell users if all the specified modes are necessary to consume the 1710 | information or if only individual modes or combinations are necessary (e.g., in a book with 1711 | audio content, the ability to read textual content may be sufficient if transcripts are 1712 | provided).

1713 | 1714 |

The accessModeSufficient property is designed to 1715 | fill this gap of understanding the combinations of modes necessary to fully consume the 1716 | information.

1717 |
1718 | 1719 | 1779 |
1780 | 1781 |
1782 |

Vocabulary

1783 | 1784 |
1785 |

auditory

1786 | 1787 |

Indicates that the resource contains information encoded in auditory form.

1788 | 1789 |
1790 |

This value is not set when the auditory content conveys no information. For example, an 1791 | instructional video might include background music while all the necessary information to 1792 | complete the task is conveyed visually and/or through text captions.

1793 |
1794 |
1795 | 1796 |
1797 |

tactile

1798 | 1799 |

Indicates that the resource contains information encoded in tactile form.

1800 | 1801 |

Note that although an indication of a tactile mode often indicates the content is encoded using a 1802 | braille system, this is not always the case. Tactile perception may also indicate, for example, 1803 | the use of tactile graphics to convey information.

1804 |
1805 | 1806 |
1807 |

textual

1808 | 1809 |

Indicates that the resource contains information encoded in textual form.

1810 | 1811 |
1812 |

This value is not set if the only textual content is for navigational purposes. For example, 1813 | an audiobook might include a table of contents, but it is not necessary to read the table of 1814 | contents to read the work. Likewise, books with synchronized text-audio playback may only 1815 | include headings to allow structured navigation.

1816 |
1817 |
1818 | 1819 |
1820 |

visual

1821 | 1822 |

Indicates that the resource contains information encoded in visual form.

1823 | 1824 |
1825 |

This value is not set if the only visual imagery is presentational or not directly relevant 1826 | to understanding the content. Examples of this type of imagery include cover images for 1827 | publications, corporate logos, and purely decorative images.

1828 |
1829 |
1830 |
1831 | 1832 |
1833 |

Visual content indicators

1834 | 1835 |
1836 |

Caution: Although user agents should infer a visual access mode when any of 1837 | the values defined in this section is set, it is strongly recommended not to rely on this 1838 | behaviour. Always set the value visual in addition to these indicators.

1839 |
1840 | 1841 |

The visual content indicators are not strictly access modes but combine a visual access mode with 1842 | information about the nature of the visual content in a publication, such as whether charts, music, 1843 | or math equations are encoded as images.

1844 | 1845 |

Users can then decide whether the content will still meet their needs. For example, if the math 1846 | equations in a textbook are encoded as images, with only text descriptions to make them accessible, 1847 | a user might opt to keep searching for an alternative that uses MathML markup.

1848 | 1849 |
1850 |

chartOnVisual

1851 | 1852 |

Indicates that the resource contains charts encoded in visual form.

1853 |
1854 | 1855 |
1856 |

chemOnVisual

1857 | 1858 |

Indicates that the resource contains chemical equations encoded in visual form.

1859 |
1860 | 1861 |
1862 |

colorDependent

1863 | 1864 |

Indicates that the resource contains information encoded such that color perception is 1865 | necessary.

1866 |
1867 | 1868 |
1869 |

diagramOnVisual

1870 | 1871 |

Indicates that the resource contains diagrams encoded in visual form.

1872 |
1873 | 1874 |
1875 |

mathOnVisual

1876 | 1877 |

Indicates that the resource contains mathematical notations encoded in visual form.

1878 |
1879 | 1880 |
1881 |

musicOnVisual

1882 | 1883 |

Indicates that the resource contains musical notation encoded in visual form.

1884 |
1885 | 1886 |
1887 |

textOnVisual

1888 | 1889 |

Indicates that the resource contains text encoded in visual form.

1890 |
1891 |
1892 |
1893 |
1894 |

The accessModeSufficient property

1895 | 1896 |
1897 |

Application

1898 | 1899 |
1900 |

A list of single or combined accessModes that are sufficient to understand all the intellectual 1901 | content of a resource.

1902 |
1903 | 1904 |

Although the access modes indicate how the information is encoded in its 1905 | default form, knowing the encoding only describes one possible perceptual pathway through the 1906 | content. For example, a book with textual and visual content will, at the most basic level, require 1907 | an individual who can read text and view images.

1908 | 1909 |

The author of the content may, however, provide alternatives to a specific access mode that allow the 1910 | content to be wholly consumed in another manner. The use of alternative text and extended 1911 | descriptions, for example, can allow a user who cannot perceive visual content to read all the 1912 | information in textual form (e.g., through text-to-speech playback).

1913 | 1914 |

In such a case, a resource with textual and visual access modes could have both a textual and visual 1915 | sufficient access mode and a purely textual access mode — because there are text 1916 | equivalents for the visual content. Specifying there is an additional textual-only pathway through 1917 | the content allows users of screen readers, for example, to recognize that the content will be 1918 | readable by them.

1919 | 1920 |

It is for this reason that content that has multiple access modes may have one or more sets of 1921 | sufficient access modes: each listing of sufficient access modes provides users with one possible 1922 | combination of reading modes that allow the content to be read in full.

1923 | 1924 |

Although listing the combinations of access modes that allow a user to read all the content is 1925 | helpful, the most important sufficient access modes to list are the single-value ones. Users looking 1926 | for an alternative to the default encoding of the content typically are looking for a single 1927 | presentation mode (e.g., a fully textual pathway to use with a text-to-speech renderer or a fully 1928 | auditory pathway to listen to).

1929 | 1930 |

The expected value of the accessModeSufficient property is an ItemList. Each entry in the ItemList must be a list of 1932 | one or more access modes representing one pathway.

1933 | 1934 |

For formats incapable of expressing lists, the property should be repeated for each set of sufficient 1935 | access modes. In these cases, it is recommended to use a comma-separated list of values.

1936 | 1937 | 2032 |
2033 | 2034 |
2035 |

Vocabulary

2036 | 2037 |
2038 |

auditory

2039 | 2040 |

Indicates that auditory perception is necessary to consume the information.

2041 |
2042 | 2043 |
2044 |

tactile

2045 | 2046 |

Indicates that tactile perception is necessary to consume the information.

2047 |
2048 | 2049 |
2050 |

textual

2051 | 2052 |

Indicates that the ability to read textual content is necessary to consume the information.

2053 | 2054 |

Note that reading textual content does not require visual perception, as textual content can be 2055 | rendered as audio using a text-to-speech capable device or assistive technology.

2056 |
2057 | 2058 |
2059 |

visual

2060 | 2061 |

Indicates that visual perception is necessary to consume the information.

2062 |
2063 |
2064 |
2065 |
2066 |

Examples

2067 | 2068 |
2069 |

Book

2070 | 2071 |

The following example shows how accessibility metadata could be used to enhance a library record 2072 | available on the Web.

2073 | 2074 |
2075 | 
<div itemscope="" itemtype="http://schema.org/Book">
2076 |    <meta itemprop="bookFormat" content="EBook/DAISY3" />
2077 |    <meta itemprop="accessibilityFeature" content="ARIA" />
2078 |    <meta itemprop="accessibilityFeature" content="largePrint" />
2079 |    <meta itemprop="accessibilityFeature" content="highContrastDisplay" />
2080 |    <meta itemprop="accessibilityFeature" content="displayTransformability" />
2081 |    <meta itemprop="accessibilityFeature" content="longDescription" />
2082 |    <meta itemprop="accessibilityFeature" content="alternativeText" />
2083 |    <meta itemprop="accessibilityFeature" content="readingOrder" />
2084 |    <meta itemprop="accessibilityFeature" content="structuralNavigation" />
2085 |    <meta itemprop="accessibilityFeature" content="tableOfContents" />
2086 |    <meta itemprop="accessibilityControl" content="fullKeyboardControl" />
2087 |    <meta itemprop="accessibilityControl" content="fullMouseControl" />
2088 |    <meta itemprop="accessibilityHazard" content="none" />
2089 |    <dl>
2090 |       <dt>Name:</dt>
2091 |       <dd itemprop="name">Holt Physical Science</dd>
2092 |       <dt>Brief Synopsis:</dt>
2093 |       <dd itemprop="description">NIMAC-sourced textbook</dd>
2094 |       <dt>Long Synopsis:</dt>
2095 |       <dd>N/A</dd>
2096 |       <dt>Book Quality:</dt>
2097 |       <dd>Publisher Quality</dd>
2098 |       <dt>Book Size:</dt>
2099 |       <dd itemprop="numberOfPages">598 Pages</dd>
2100 |       <dt>ISBN-13:</dt>
2101 |       <dd itemprop="isbn">9780030426599</dd>
2102 |       <dt>Publisher:</dt>
2103 |       <dd itemprop="publisher" itemtype="http://schema.org/Organization" itemscope="">Holt, Rinehart
2104 |          and Winston</dd>
2105 |       <dt>Date of Addition:</dt>
2106 |       <dd>06/08/10</dd>
2107 |       <dt>Copyright Date:</dt>
2108 |       <dd itemprop="copyrightYear">2007</dd>
2109 |       <dt>Copyrighted By:</dt>
2110 |       <dd itemprop="copyrightHolder" itemtype="http://schema.org/Organization" itemscope="">Holt,
2111 |          Rinehart and Winston</dd>
2112 |       <dt>Adult content:</dt>
2113 |       <dd><meta itemprop="isFamilyFriendly" content="true" />No</dd>
2114 |       <dt>Language:</dt>
2115 |       <dd><meta itemprop="inLanguage" content="en-US" />English US</dd>
2116 |       <dt>Essential Images:</dt>
2117 |       <dd>861</dd>
2118 |       <dt>Described Images:</dt>
2119 |       <dd>910</dd>
2120 |       <dt>Categories:</dt>
2121 |       <dd><span itemprop="genre">Educational Materials</span></dd>
2122 |       <dt>Grade Levels:</dt>
2123 |       <dd>Sixth grade, Seventh grade, Eighth grade</dd>
2124 |       <dt>NIMAC:</dt>
2125 |       <dd>This book is currently only available to public K-12 schools and organizations in the United
2126 |          States for use with students with an IEP, because it was created from files supplied by the
2127 |          NIMAC under these restrictions. Learn more in the NIMAC Support Center.</dd>
2128 |    </dl>
2129 |    
2130 |    <div class="bookReviews" itemprop="aggregateRating" itemscope=""
2131 |       itemtype="http://schema.org/AggregateRating">
2132 |       <h2>Reviews of Holt Physical Science (<span itemprop="reviewCount">0</span> reviews)</h2>
2133 |       <div class="bookReviewScore">
2134 |          <span><span itemprop="ratingValue">0</span> - No Rating Yet</span>
2135 |       </div>
2136 |    </div>
2137 | </div>
2138 |
2139 |
2140 | 2141 |
2142 |

Video

2143 | 2144 |

This example shows how the accessibility metadata could be used to augment a record for a video.

2145 | 2146 |
2147 | 
<dl itemtype="http://schema.org/VideoObject" itemscope="">
2148 |    <dt>Title:</dt>
2149 |    <dd itemprop="name">Arctic Climate Perspectives</dd>
2150 |    <dt>Description:</dt>
2151 |    <dd itemprop="description">This video, adapted from material provided by the ECHO
2152 |       partners, describes how global climate change is affecting Barrow, Alaska.</dd>
2153 |    <dt>Adaptation Type:</dt>
2154 |    <dd><span itemprop="accessibilityFeature">captions</span></dd>
2155 |    <dt>Access Mode:</dt>
2156 |    <dd>auditory, visual</dd>
2157 |    <dt>URL:</dt>
2158 |    <dd><a itemprop="url" href="http://www.example.org/asset/echo07_vid_climate"
2159 |       >http://www.example.org/asset/echo07_vid_climate</a>/</dd>
2160 |    <dt>Has Adaptation:</dt>
2161 |    <dd>http://www.example.org/asset/echo07_vid_climate_dvs/</dd>
2162 |    <dt>Subjects:</dt>
2163 |    <dd><span itemprop="about">National K-12 Subject::Science::Earth and Space
2164 |       Science::Water Cycle, Weather, and Climate::Structure and Composition of the
2165 |       Atmosphere, National K-12 Subject::Science::Earth and Space Science::Water Cycle,
2166 |       Weather, and Climate::Climate</span></dd>
2167 |    <dt>Education Level:</dt>
2168 |    <dd>Grade 6, Grade 7, Grade 8, Grade 9</dd>
2169 |    <dt>Audience:</dt>
2170 |    <dd><span itemprop="intendedEndUserRole">Learner</span></dd>
2171 |    <dt>Resource Type:</dt>
2172 |    <dd><span itemprop="genre">Audio/Visual</span>,
2173 |       <span itemprop="genre">Movie/Animation</span></dd>
2174 |    <dt>Language:</dt>
2175 |    <dd><span itemprop="inLanguage">en-US</span></dd>
2176 |    <dt>Publication Date:</dt>
2177 |    <dd itemprop="datePublished">2007-02-12</dd>
2178 |    <dt>Rights:</dt>
2179 |    <dd>Download and Share, <a itemprop="useRightsUrl"
2180 |       href="http://www.example.org/oerlicense/2/"
2181 |       >http://www.example.org/oerlicense/2/</a></dd>
2182 | </dl>
2183 |
2184 |
2185 |
2186 |
2187 |

Change log

2188 | 2189 |

Note that this change log only identifies substantive changes to the vocabulary — those that add or 2190 | deprecate terms, or are similarly noteworthy.

2191 | 2192 |

For a list of all issues addressed (typos, minor definition modifications, etc.), refer to the Community Group's 2194 | issue tracker.

2195 | 2196 | 2200 | 2201 |
2202 | Changes made in 2025 2203 | 2208 |
2209 | 2210 |
2211 | Changes made in 2024 2212 | 2226 |
2227 | 2228 |
2229 | Changes made in 2023 2230 | 2251 |
2252 | 2253 |
2254 | Changes made in 2022 2255 | 2286 |
2287 |
2288 |
2289 |

Acknowledgments

2290 | 2291 |

The editors would like to thank the Accessibility Discoverability Vocabulary for Schema.org Community Group participants for their 2293 | ongoing input and suggestions to improve this vocabulary.

2294 | 2295 |

Additional thanks go to the original participants of the Accessibility Metadata Project for their work bringing the properties and vocabularies to 2297 | reality.

2298 |
2299 | 2337 | 2338 | 2339 | --------------------------------------------------------------------------------