Background
-Books and other publications have constructs such as chapters, parts, footnotes and more that are not commonly found on web pages. The visual presentation of these constructs makes it obvious to the sighted reader what the semantics are. These semantic constructs can now be added to HTML and XHTML by using DPUB Aria roles and then used for presentation through Assistive Technology. The Publishing Community Group at the W3C continues to promote these roles for browsers, in EPUB Reading Systems, and for published digital materials.
-To improve the reading experience for screen reader users, the presentation of these semantic constructs is recommended. Some of the roles are extremely important to present to the reader, while others are of less importance or a matter of reader preference. In this XHTML document, the Transition to Accessible EPUB working group in the DAISY Consortium is making suggestions as to the importance of the roles and what might be presented. This document provides the necessary information that screen reader implementors should consider. It can also be used for testing purposes.
+Books and other publications have constructs such as chapters, parts, footnotes and more that are not commonly found on web pages. The visual presentation of these constructs makes it obvious to the sighted reader what the document semantics are. These document semantic constructs can now be added to HTML and XHTML by using DPUB Aria roles and then used for presentation through Assistive Technology. The Publishing Community Group at the W3C continues to promote these roles for browsers, in EPUB Reading Systems, and for published digital materials.
+To improve the reading experience for screen reader users, the presentation of these document semantic constructs is recommended. Some of the roles are extremely important to present to the reader, while others are of less importance or a matter of reader preference. In this XHTML document, the Transition to Accessible EPUB working group in the DAISY Consortium is making suggestions as to the importance of the roles and what might be presented. This document provides the necessary information that screen reader implementors should consider. It can also be used for testing purposes.
Each item should be self-explanatory and indicate the (1) importance and (2) what should be presented.
Screen Reader Implementation
There are currently 39 DPUB Aria roles which are prefixed with "doc-" before the name of the publishing construct, e.g. doc-chapter for a chapter. A list of the roles, their importance, suggested output, actions to be considered, and support in browsers can be found at: Google Sheet showing DPUB Aria roles and suggestions for implementors.
The following are presented for testing purposes. Included in the example is a description of the test, its importance, and suggested output, which corresponds to the Google sheet linked above.
-Importance of vocalizing or presenting constructs:
+ +The document semantic verbosity i.e., selection of the amount of document semantics to vocalize or present, could be grouped as "all," "most", "some," or None."
+-
-
- critical
- should always be presented -
- high
- should be presented most of the time -
- medium
- should be presented some of the time -
- low
- should be presented with the highest verbosity setting +
- critical
- should always be presented, unless the document semantic verbosity "none" is selected. +
- high
- should be presented when the document semantic verbosity "some," "most," or "all"is selected. +
- medium
- should be presented when the document semantic verbosity "most" or "all" is selected. +
- low
- should be presented when the document semantic verbosity "all" is selected.
Valid Aria Role Complementary Test
-div element has the role of complementary.
- Note: a document semantic verbosity selection of "some" includes critical and high importance. A verbosity selection of "most includes critical, high, and medium.
doc-abstract Test
This is a high priority. Many times the word "abstract" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the word "abstract" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "abstract"
-doc-acknowledgments Test
+doc-acknowledgments Test
div element has the role of acknowledgments.This is a low priority. Many times the word "Acknowledgements" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
-Suggested output: "acknowledgements"
+This is a low priority. Many times the word "Acknowledgements" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
+Suggested output: "acknowledgments"
doc-afterword Test
This is a medium priority. Many times the word "Afterword" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "Afterword" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to Most or all.
Suggested output: "afterword"
doc-appendix Test
div element has the role of appendix.This is a medium priority. Many times the word "Appendix" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "Appendix" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "appendix"
doc-backlink Test
a backlink -This is a critical priority. The vocalization of the information that it is a back link should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a back link should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "back link"
This is an "actionable item" meaning the user would follow the back link to return to the identified position in the publication.
doc-bibliography Test
@@ -58,40 +59,40 @@div element has bibliography role. Test added to check if it acts differently from role on section tag.This is a medium priority. Many times the word "bibliography" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "bibliography" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to Most or all.
Suggested output: "bibliography"
doc-biblioref Test
a role of biblioref. -This is a critical priority. The vocalization of the information that it is a Bibliographic reference link should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a Bibliographic reference link should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "bibliographic reference"
This is an "actionable item" meaning the user would follow the link to go to the reference identified.
doc-chapter Test
This is a high priority. Many times the word "chapter" will not appear in the heading. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the word "chapter" will not appear in the heading. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "chapter"
doc-colophon Test
This is a low priority. Many times the word "colophon" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
+This is a low priority. Many times the word "colophon" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
Suggested output: "colophon"
doc-conclusion Test
This is a medium priority. Many times the word "conclusion" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "conclusion" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "conclusion"
doc-cover Test
- This is a medium priority. Many times the word "Cover" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "Cover" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output, "cover"
doc-credit Test
This is a low priority. Many times the word "credit" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
+This is a low priority. Many times the word "credit" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
Suggested output: "credit"
doc-credits Test
This is a low priority. Many times the word "credits" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
+This is a low priority. Many times the word "credits" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
Suggested output: "credits"
doc-dedication Test
This is a medium priority. Many times the word "dedication" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "dedication" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "dedication"
doc-endnotes Tests
This is a critical priority. Many times the word "end notes" would be included in the heading associated with this item. It should be vocalized all of the time.
+This is a critical priority. Many times the word "end notes" would be included in the heading associated with this item. It should be vocalized all of the time, unless the document semantic verbosity of none is selected.
Suggested output: "endnotes"
div element has the endnotes role. Test added to check if it acts differently from role on section tag.doc-epigraph Test
This is a low priority. Many times the word "epigraph" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
+This is a low priority. Many times the word "epigraph" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
Suggested output: "epigraph"
doc-epilogue Test
This is a medium priority. Many times the word "epilogue" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "epilogue" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "epilogue"
doc-errata Test
This is a low priority. Many times the word "errata" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to low.
+This is a low priority. Many times the word "errata" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to all.
Suggested output: "errata"
doc-example Test
This is a medium priority. Many times the word "example" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "example" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "example"
doc-footnote Test
This is a critical priority. Many times the word "footnote" would be included in the heading associated with this item. It should always be vocalized.
+This is a critical priority. Many times the word "footnote" would be included in the heading associated with this item. It should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "footnote"
doc-foreword Test
This is a medium priority. Many times the word "foreword" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "foreword" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "foreword"
doc-glossary Test
This is a medium priority. Many times the word "glossary" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "glossary" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "glossary"
foo role of term.: bar role of definition.doc-glossref Test
a glossary reference -This is a critical priority. The vocalization of the information that it is a glossary reference link should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a glossary reference link should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "glossary reference"
This is an "actionable item" meaning the user would follow the link to go to the reference identified.
doc-index Test
This is a medium priority. Many times the word "index" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "index" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to Most or all.
Suggested output: "index"
doc-introduction Test
This is a medium priority. Many times the word "introduction" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "introduction" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "introduction"
doc-noteref Test
a note reference -This is a critical priority. The vocalization of the information that it is a note reference link should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a note reference link should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "note reference"
This is an "actionable item" meaning the user would follow the link to go to the reference identified.
doc-notice Test
This is a high priority. - the word "notice or caution" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to high. + the word "notice or caution" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "notice"
doc-pagebreak Test
In this text there is a pagebreak .
-This is a critical priority. The vocalization of the information that it is a page break should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a page break should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "page break"
-This is an "actionable item" meaning the user would want to go to the previous or next page break. This is an excellent candidate for single letter navigation and the letter p is suggested.
+This is an "actionable item" meaning the user would want to go to the previous or next page break. This is an excellent candidate for single letter navigation .
doc-pagelist Test
This is a critical priority. The vocalization of the information that it is a list of links to pages should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a list of links to pages should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "list of pages"
This is an "actionable item" meaning the user would want to be taken to the list of pages or if they were presented with a list of pages, it would be announced.
doc-part Test
This is a high priority. Many times the word "part" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the word "part" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most, some, or all .
Suggested output: "part"
doc-preface Test
This is a medium priority. Many times the word "preface" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "preface" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "preface"
doc-prologue Test
This is a medium priority. Many times the word "prolog" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to medium.
+This is a medium priority. Many times the word "prolog" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to most or all.
Suggested output: "prolog"
doc-pullquote Test
This is a high priority. Many times emphasized portions of text are in a margin or pulled to the side. The information that emphasized text is being presented should be vocalized when the verbosity is set to high.
+This is a high priority. Many times emphasized portions of text are in a margin or pulled to the side. The information that emphasized text is being presented should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "emphasized text"
doc-qna Test
This is a high priority. Many times the words "Questions and Answers" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the words "Questions and Answers" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "questions and answers"
doc-subtitle Test
This is a high priority. Many times the subtitle is present after the title. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the subtitle is present after the title. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "subtitle"
doc-tip Test
This is a high priority. Many times the word "tip" would be included in the heading associated with this item. It should be vocalized when the verbosity is set to high.
+This is a high priority. Many times the word "tip" would be included in the heading associated with this item. It should be vocalized when the document semantic verbosity is set to some, most, or all.
Suggested output: "tip"
doc-toc Test
This is a critical priority. The vocalization of the information that it is a table of contents should always be vocalized.
+This is a critical priority. The vocalization of the information that it is a table of contents should always be vocalized, unless the document semantic verbosity of none is selected.
Suggested output: "table of contents"
This is an "actionable item" meaning the user would want to have a mechanism to go to the table of contents.
-doc-fake Test
+ +Tests to make sure nothing is voiced
+ +The next two tests should not be voiced through the DPUB ARIA roles. They are placed here only for testing purposes.
+ +doc-fake Test
Valid Aria Role Complementary Test
+div element has the role of complementary.
+