Authoring Tool Accessibility Guidelines 1.0 (working draft)

Abstract

This document is part of a series of accessibility documents published by the W3C Web Accessibility Initiative.

Status of this document

This is a draft document and may be updated, replaced or rendered obsolete by other documents at any time. It is inappropriate to use W3C Working Drafts as reference material or to cite them as other than "work in progress". This is work in progress and does not imply endorsement by either W3C or its member organizations.

The goals of the WAI AU Working Group are discussed in the WAI AU charter.

Please send comments about this document to the public mailing list: w3c-wai-au@w3.org, archived at http://lists.w3.org/Archives/Public/w3c-wai-au

A list of the current AU Working Group members is available.

1. Introduction

Each checkpoint is intended to be specific enough that it can be verified, while being sufficiently general to allow developers the freedom to use the most appropriate strategies to meet the checkpoint.

The Techniques provided in the techniques document are suggestions for how implementation might be done, or where further information can be found. They are informative only, and other strategies may be used to meet the checkpoint as well as, or in place of, those discussed.

1.2 Checkpoint priorities

Each checkpoint has a priority level. The priority level reflects the impact of the checkpoint in meeting the goals of this document. These goals are:

1. That the authoring tool be accessible
2. That the authoring tool generate accessible content by default
3. That the authoring tool encourage the creation of accessible content

The three priority levels are assigned as follows:

[Priority 1]

If the checkpoint is essential to meeting those goals

[Priority 2]

If the checkpoint is important to meeting those goals

[Priority 3]

If the checkpoint is beneficial to meeting those goals

2. Guidelines

Guideline 1. Support accessible authoring practices

Methods for ensuring accessible markup vary with different markup languages. If markup is automatically generated, many authors will be unaware of the accessibility status of the final product unless they expend extra effort to make appropriate corrections by hand. Since many authors are unfamiliar with accessibility, the onus is on the authoring tool to generate accessible markup, and where appropriate, to guide the author in producing accessible content.

Many applications feature the ability to convert documents from other formats (e.g., Rich Text Format) into a markup format, such as HTML. Markup changes may also be made to facilitate efficient editing and manipulation. These processes are usually hidden from the user's view and may create inaccessible markup or cause inaccessible markup to be produced.

Checkpoints:

1.1 Ensure the author can use accessible authoring practices for the markup language(s) supported by the tool. [Priority 1]

Techniques for checkpoint 1.1

1.2 Ensure the tool generates markup that conforms to the W3C's Web Content Accessibility Guidelines [WAI-WEBCONTENT]. [Priority 1 for level-A conformance, Priority 2 for double-A conformance, Priority 3 for triple-A conformance]

Techniques for checkpoint 1.2

1.3 Ensure that templates provided by the tool conform to W3C Web Content Accessibility Guidelines [WAI-WEBCONTENT]. [Priority 1 for level-A conformance, Priority 2 for double-A conformance, Priority 3 for triple-A conformance]

Techniques for checkpoint 1.3

1.4 Ensure the tool preserves all accessibility information during authoring, transformations and conversions. [Priority 1]

Techniques for checkpoint 1.4

Guideline 2. Generate standard markup

Conformance with standards promotes interoperability and accessibility. Where applicable use W3C recommendations, which have been reviewed to ensure accessibility and interoperability. If there are no applicable W3C Recommendations, use a published standard that enables accessibility.

Checkpoints:

2.1 Use the latest versions of W3C recommendations when they are available and appropriate for a task. [Priority 2]

These specifications have undergone review specifically to ensure that they do not compromise, and where possible they enhance, accessibility.

Techniques for checkpoint 2.1

2.2 Ensure that the tool generates valid markup. [Priority 1]

This is necessary for user agents to be able to transform Web content to a presentation appropriate to a particular user's needs.

Techniques for checkpoint 2.2

[#C+3declare extended-DTD] If markup generated by the tool differs from W3C standard, inform the author.

This is necessary for user agents to be able to transform Web content to a presentation appropriate to a particular user's needs.

Guideline 3. Support the Creation of Accessible Content

Generating equivalent information, such as textual alternatives for images and audio descriptions of video, can be one of the most challenging aspects of Web design. Along with the necessity for structural information it is a cornerstone of accessible design, allowing information to be presented in a way most appropriate for the needs of the user without constraining the creativity of the author.

Automating the mechanics of this process, by prompting authors to include the relevant information at appropriate times, can greatly ease the burden for authors. Where such information can be mechanically determined (e.g., the function of icons in an automatically-generated navigation bar, or expansion of acronyms from a dictionary) and offered as a choice for the author the tool will assist the author, at the same time as it reinforces the need for such information and the author's role in ensuring that it is used appropriately in each instance.

Checkpoints:

3.1 Assist the author to provide alternative information (e.g., captions, expanded versions of acronyms, long descriptions of graphics). (Priority 1 for alternative information that is [Web-Content-Priority-1], Priority 2 for alternative information that is [Web-Content-Priority-2], Priority 3 for alternative information that is [Web-Content-Priority-3])

Techniques for checkpoint 3.1

3.2 Help the author create structured content (Priority 1 for alternative information that is [Web-Content-Priority-1], Priority 2 for alternative information that is [Web-Content-Priority-2], Priority 3 for alternative information that is [Web-Content-Priority-3])

Techniques for checkpoint 3.2

3.3 Ensure prepackaged content conforms to WCAG. (Priority 1 for alternative information that is [Web-Content-Priority-1], Priority 2 for alternative information that is [Web-Content-Priority-2], Priority 3 for alternative information that is [Web-Content-Priority-3])

Example: movies with text and audio equivalents. (Refer also to [##C-no-default-alt])

Techniques for checkpoint 3.3

3.4 Do not insert automatically generated (e.g., the filename) or place-holder (e.g., "image") equivalent text, except in cases where human-authored text has been written for an object whose function is known with certainty. [Priority 1]

For example, in an automatically generated navigation bar, it is clear that "search" is appropriate for a button linked to a search function

Techniques for checkpoint 3.4

3.5 Provide a mechanism to manage alternative information for multimedia objects, that retains and offers for editing pre-written or previously linked alternative information. [Priority 3]

Techniques for checkpoint 3.5

Guideline 4. Provide methods of checking and correcting inaccessible content

Many authoring tools allow authors to create documents with little or no knowledge about the underlying markup. To ensure accessibility, authoring tools must be designed so that they may automatically identify inaccessible markup, and enable its correction even when the markup itself is hidden from the author.

In supporting the creation of accessible Web content, authoring tools should take into account the differing authoring styles of their users. In general, authors will prefer to be able to configure their tools to support their working style. Tools that allow such configuration can help authors to feel that accessible authoring is a natural practice (see also the previous guideline) rather than an intrusion on their normal work pattern. For example some users may prefer to be alerted to problems when they occur, whereas others may prefer to perform a check after the document is completed. This is analogous to programming environments that allow users to decide whether to check for correct code during editing or at compile time.

Note that many assistive technologies used with browsers and multimedia players are only able to provide access to Web documents that use valid mark-up. Therefore validation of mark-up is an essential aspect of authoring tool accessibility.

Checkpoints:

4.1 Check for and alert the author to accessibility problems. (Priority 1 for accessibility problems that are [Web-Content-Priority-1], Priority 2 for accessibility problems that are [Web-Content-Priority-2], Priority 3 for accessibility problems that are [Web-Content-Priority-3])

Techniques for checkpoint 4.1

4.2 Assist authors in correcting accessibility problems. (Priority 1 for accessibility problems that are [Web-Content-Priority-1], Priority 2 for accessibility problems that are [Web-Content-Priority-2], Priority 3 for accessibility problems that are [Web-Content-Priority-3])

Techniques for checkpoint 4.2

4.3 Allow the author to preserve markup not recognized by the tool. [Priority 2]

Notes:

1. The author may have included or imported markup that is not recognized by the tool, but which enhances accessibility.
2. This need not be the default setting.

Techniques for checkpoint 4.3

4.4 Provide the author with a summary of the document accessibility status. [Priority 3]

Techniques for checkpoint 4.4

4.5 Allow the author to transform presentation markup that is misused to convey structure into structural markup, and to transform presentation markup that is stylistic into style sheet markup. [Priority 3]

Techniques for checkpoint 4.5

Guideline 5. Integrate accessibility solutions into the overall "look and feel"

When a new feature is added to an existing software tool without proper integration, the result is often an obvious discontinuity. Differing color schemes, fonts, interaction styles and even application stability can be factors affecting user acceptance of the new feature.

Checkpoints:

5.1 Ensure that functionalities related to accessible Authoring practices are integrated into the tool [Priority 2]

Techniques for checkpoint 5.1

5.2 Ensure that the [Web-Content-Priority-1] accessible authoring practices are among the most obvious and easily initiated by the author. [Priority 2]

Techniques for checkpoint 5.2

Guideline 6. Promote accessibility in help and documentation

The issues surrounding Web accessibility are often unknown to Web authors. Help and documentation should explain accessibility problems and solutions, with examples.

Checkpoints:

6.1 Integrate accessible authoring practices in all applicable help topics. [Priority 1]

Techniques for checkpoint 6.1

6.2 Explain the accessible authoring practices supported by the authoring tool. [Priority 1]

Techniques for checkpoint 6.2

6.3 Ensure that all documentation examples show how to produce content that conforms to W3C Web Content Accessibility Guidelines [WAI-WEBCONTENT]. [Priority 1 for level-A conformance, Priority 2 for double-A conformance, Priority 3 for triple-A conformance]

Note: An example may be built from several parts, some of which are not themselves conformant, so long as those parts are identified and linked to a conforming example.

Techniques for checkpoint 6.3

6.4 Emphasize the universal benefit of accessible design. [Priority 3]

Techniques for checkpoint 6.4

Guideline 7. Ensure that the Authoring Tool is Accessible to Authors with Disabilities

The authoring tool is a software program with standard user interface elements and as such should follow relevant user interface accessibility guidelines. In addition to applicable general interface accessibility guidelines there are interface design considerations that are specific to Web authoring tools.

One such consideration is that the author may need a different presentation to edit the Web content than the one they wish ultimately to be displayed. This implies display preferences that do not manifest themselves in the ultimate markup or style declarations.

Another consideration relates to the process of navigating and manipulating the document while authoring. Authoring Web content requires editing a potentially large and complex document. In order to edit a document the author must be able to locate and select specific elements, efficiently traverse the document, and quickly find and mark insertion points. Authors who use screen readers, refreshable braille displays, or screen magnifiers can make limited use (if at all) of visual artifacts that communicate the structure of the document and act as sign posts when traversing the document. Authors who use keyboard and mouse alternatives must make tiring repetitions of movement commands to navigate the document. There are strategies that make it easier to navigate and manipulate a marked-up document. Using the structure of a Web document, the author can be given a view of the document which allows the author to both get a good sense of the overall document and to navigate that document more easily.

Checkpoints:

7.1 Use all applicable operating system and accessibility standards and conventions (Priority 1 for standards and conventions which are essential to accessibility, Priority 2 for those that are important to accessibility, Priority 3 for those that are beneficial to accessibility). [Priority 1]

Techniques for checkpoint 7.1

7.2 Allow the author to change the editing view without affecting the document markup. [Priority 1]

This allows the author to edit the document according to their personal requirements, without changing the way the document looks or is rendered when published.

Techniques for checkpoint 7.2

7.3 Ensure that each element's properties are accessible to the author . [Priority 1]

Techniques for checkpoint 7.3

7.4 Allow the author to edit all properties of each element and object in an accessible fashion. [Priority 1]

Techniques for checkpoint 7.4

7.5 Ensure the editing view allows navigation via the structure of the document. [Priority 1]

Techniques for checkpoint 7.5

7.6 Enable editing of the structure of the document. [Priority 2]

Techniques for checkpoint 7.6

7.7 Allow the author to search within editing views. [Priority 2]

Techniques for checkpoint 7.7

3. Terms and Definitions

User Configurable Schedule

A user configurable schedule allows the user to determine the type of prompts and alerts that are used, including when they are presented.

Prompts

Prompts are requests for user input, either information or a decision. Prompts require author response.

Alerts

Alerts notify the author of something, or mark something for the author's attention. They may or may not require author response.

Authoring Tool

As used in this document, an Authoring Tool is any software that is used to generate content for publishing on the Web. See also section 1.3 Scope of these guidelines.

Transformation

A process whereby one object is changed, according to a discrete set of rules, into another, equivalent, object. This includes any application or application feature that allows content that is marked up in a particular markup language to be transformed into another markup language, such as software that allows the author to change the DTD defined for the original document to another DTD. .

Document

A document is a series of elements that are defined by a language (e.g., HTML 4.0 or an XML application).

Element

An element is any identifiable object within a document, for example a character, word, image, paragraph or spreadsheet cell. In HTML and XML an element refers to a pair of tags and their content, or an "empty" tag - one that has no closing tag or content.

Property

A property is a piece of information about an element, for example structural information (e.g., it is item number 7 in a list, or plain text) or presentation information (e.g., that it is marked as bold, its font size is 14). In XML and HTML properties of an element include the name of the element (e.g., IMG or DL), the values of its attributes, and information associated by means of a style sheet. In a database, properties of a particular element may include values of the entry, and acceptable data types for that element.

Attributes

in XML and HTML, an element may have any number of attributes. In the following example, the attributes of the beverage element are flavor, which has the value "lots", and colour, which has the value "red": <beverage flavor="lots" colour="red">my favorite</beverage> Some attributes are integral to document accessibility (e.g., the "alt", "title", and "longdesc" attributes in HTML

Rendered Content

The rendered content is that which an element actually causes to be rendered by the user agent. This may differ from the element's structural content. For example, some elements cause external data to be rendered (e.g., the IMG element in HTML), and in some cases, browsers may render the value of an attribute (e.g., "alt", "title") in place of the element's content.

Accessible, Accessibility

Within these guidelines, Accessible and Accessibility are used in the sense of being accessible to people regardless of disability.

Accessibility Information

Accessibility information is content, including information and markup, which is used to improve the accessibility of a document.

Accessibility Solution, Accessible Authoring Practice

These terms refer to Authoring practices that improve the accessibility of content generated by the tool.

Alternative Presentations and Alternative Information

Certain types of content may not be accessible to all users (e.g., images or audio presentations), so alternative representations are used, such as transcripts for audio, or short functionally equivalent text (e.g., "site map link") and/or descriptive text equivalents (e.g., "Graph 2.5 shows that the population has doubled approximately every ten years for the last fifty years, increasing from about 10 million to 330 million in that time"). An object may have several alternative representations, for example a video, captions of the audio, audio description of the video, a series of still images, and textual representations of each of these.

Views

An authoring tool may offer several views of the same document. For instance, one view may show raw markup, a second may show a structured tree view, a third may show markup with rendered objects while a final view shows an example of how the document may appear if it were to be rendered by a particular browser.

Editing view

What is displayed by the authoring tool to the author during the editing process.

Markup Language

The term markup language is used in this document to refer to the encoding language of a document, such as HTML, SVG, or MathML.

4. Acknowledgments

Many thanks to the following people who have contributed through review and comment: Jim Allan, Denis Anson, Kynn Bartlett, Harvey Bingham, Judy Brewer, Carl Brown, Dick Brown, Kelly Ford, Wendy Chisholm, Rob Cumming, Daniel Dardailler, Mark Day, BK Delong, Jamie Fox, Edna French, Sylvain Galineau, Al Gilman, Eric Hansen, Phill Jenkins, Len Kasday, Brian Kelly, Marja-Riitta Koivunen, Jaap van Lelieveld, William Loughborough, Karen McCall, Charles Oppermann, Dave Pawson, Dave Poehlman, Bruce Roberts, Chris Ridpath, Gregory Rosmaita, Jim Thatcher, Irène Vatton, Gregg Vanderheiden, Pawan Vora, Jason White, and Lauren Wood.

If you have contributed to the AU guidelines and your name does not appear please contact the editors to add your name to the list.

5. References

For the latest version of any W3C specification please consult the list of W3C Technical Reports.

[HTML40]

"HTML 4.0 Recommendation", D. Raggett, A. Le Hors, and I. Jacobs, eds., 17 December 1997, revised 24 April 1998. This HTML 4.0 Recommendation is http://www.w3.org/TR/1998/REC-html40-19980424. The latest version of HTML 4.0 is available at http://www.w3.org/TR/REC-html40.

[WAI-AUTOOLS-TECH]

"Authoring Tool Accessibility Techniques (Working Draft)", J. Treviranus, J. Richards, I. Jacobs, and C. McCathieNevile eds. The latest draft of the Techniques for Authoring Tool Accessibility Guidelines is available at http://www.w3.org/WAI/AU/WAI-AUTOOLS.

[WAI-USERAGENT]

"User Agent Accessibility Guidelines", J. Gunderson and I. Jacobs, eds. The latest version of the User Agent Accessibility Guidelines is available at http://www.w3.org/WAI/UA/WAI-USERAGENT.

[WAI-WEBCONTENT]

"Web Content Accessibility Guidelines 1.0", W. Chisholm, G. Vanderheiden, and I. Jacobs, eds., 5 May 1999. This Recommendation is http://www.w3.org/TR/1999/WAI-WEBCONTENT-19990505. The latest version of the Web Content Accessibility Guidelines 1.0" is available at http://www.w3.org/TR/WAI-WEBCONTENT/.

[WAI-WEBCONTENT-TECHS]

"Techniques for Web Content Accessibility Guidelines 1.0", W. Chisholm, G. Vanderheiden, and I. Jacobs, eds. The latest version of Techniques for Web Content Accessibility Guidelines 1.0 is available at http://www.w3.org/TR/WAI-WEBCONTENT-TECHS/.

[Web-Content-Priority]

Priorities defined by [WAI-WEBCONTENT].