Copyright ©2001W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document use and software licensing rules apply.
This specification provides guidelines for Web authoring tool developers. Its purpose is two-fold: to assist developers in designing authoring tools that produce accessible Web content and to assist developers in creating an accessible authoring interface.
Authoring tools can enable, encourage, and assist users ("authors") in the creation of accessible Web content through prompts, alerts, checking and repair functions, help files and automated tools. It is just as important that all people be able to author content as it is for all people to have access to it. The tools used to create this information must therefore be accessible themselves. Adoption of these guidelines will contribute to the proliferation of Web content that can be read by a broader range of readers and authoring tools that can be used by a broader range of authors.
This document is part of a series of accessibility documents published by the W3C Web Accessibility Initiative (WAI).
This section describes the status of this document at the time of its publication. Other documents may supersede this document. The latest status of this document series is maintained at the W3C.
This document has been produced by the Authoring Tool Accessibility Guidelines Working Group (AUWG), part of the Web Accessibility Initiative (WAI). The goals of the Working Group are discussed in the AUWG charter.
This document has been made available to the WAI Interest Group for review, but is not endorsed by them. This is a working draft, and it is not endorsed by the W3C or its members. It is inappropriate to refer to this document other than as "work in progress".
This is the first Public Working Draft of a document which may eventually supersede the W3C Recommendation Authoring Tool Accessibility Guidelines 1.0 [ATAG10]. The Working Group has made it available for review by W3C Members and other interested parties, in accordance with W3C Process.
This draft refers to the Web Content Accessibility Guidelines (WCAG) 1.0 for specification of accessible content. It is expected (but not guaranteed) that if Web Content Accessibility Guidelines 2.0 [WCAG20] (currently in Working Draft status) becomes a W3C Recommendation, the Authoring Tool Accessibility Guidelines "Wombat" document will refer to WCAG 2.0 and become Authoring Tool Accessibility Guidelines version 2.0.
The Working Group expects the current "Wombat" draft to be backwards-compatible with ATAG 1.0, or at most to make only minor changes in requirements. Before this document reaches last call, the Working Group will publish a detailed analysis of the differences in requirements. This version is expected to be easier to use. It results from experience with ATAG 1.0, and working group review of previous versions of this draft, and is intended to fulfill the requirements for a new version set by the Working Group.
As an initial internal draft, this document still refers (non-normatively) to the Techniques for Authoring Tool Accessibility1.0 [ATAG10-TECHS]. As part of development of this draft, it is expected that the working group will draft a matching version of the Techniques information.
Please send general comments about this document to the public mailing list: [email protected] (public archives). Outstanding issues identified by the Working group are marked within this document, and the Working Group particularly welcomes comment on those. Issues which are under consideration and those which have been resolved by the working group are listed in the document ATAG "Wombat" Issues. A log of changes between successive Working Drafts is available.
A list of current W3C Recommendations and other technical documents including Working Drafts and Notes can be found at http://www.w3.org/TR.
An appendix to this document lists all checkpoints for convenient reference.
In these guidelines, the term "authoring tool" refers to the wide range of software used for creating Web content, including:
The goals of this document can be stated as follows: that the authoring tool be accessible to authors regardless of disability, that it produce accessible content by default, and that it support and encourage the author in creating accessible content. Because most of the content of the Web is created using authoring tools, they play a critical role in ensuring the accessibility of the Web. Since the Web is both a means of receiving information and communicating information, it is important that both the Web content produced and the authoring tool itself be accessible.
To achieve these goals, authoring tool developers must take steps such as ensuring conformance to accessible standards (e.g., HTML 4), checking and correcting accessibility problems, prompting, and providing appropriate documentation and help. For detailed information about what constitutes accessible content, these guidelines rely on the Web Content Accessibility Guidelines 1.0 [WCAG10]. Similarly, rather than directly reproducing existing specifications that address general accessible software design, these guidelines rely on other sources. The present guidelines do address accessible design considerations specific to Web authoring tools such as providing flexible editing views, navigation aids and access to display properties for authors.
The principles set forth in these guidelines will benefit many people who do not have a disability but who have similar needs. This includes people who work in noisy or quiet environments where the use of sound is not practical, people who need to use their eyes for another task and are unable to view a screen, and people who use small mobile devices that have a small screen, no keyboard, and no mouse.
A separate document, entitled "Techniques for Authoring Tool Accessibility Guidelines 1.0" [ATAG10-TECHS], provides suggestions and examples of how each checkpoint might be satisfied. It also includes references to other accessibility resources (such as platform-specific software accessibility guidelines) that provide additional information on how a tool may satisfy each checkpoint. Readers are strongly encouraged to become familiar with the Techniques Document as well as "Techniques for Web Content Accessibility Guidelines 1.0" [WCAG10-TECHS] and "Techniques for User Agent Accessibility Guidelines 1.0" [UAAG10-TECHS].
Note: The techniques in [ATAG10-TECHS] are informative examples only. Other strategies may be used to satisfy the checkpoints in addition to, or in place of, those discussed in [ATAG10-TECHS].
Note: Authoring tools that conform to this document will propagate accessible Web content and be useful to anyone regardless of disability. There will also be authoring tools that produce accessible content in favorable circumstances (e.g., a text editor used by a motivated author), or provide an accessible interface to authors with certain disabilities, but that do not conform to these guidelines.
The seven guidelines in this document are general principles for accessible design. Each guideline includes:
The checkpoint definitions in each guideline specify requirements for authoring tools to follow the guideline. Each checkpoint definition includes:
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 satisfy it.
An appendix to this specification [WOMBAT-CHECKLIST] lists all checkpoints, ordered by priority, for convenient reference.
Each checkpoint has a priority level. The priority level reflects the impact of the checkpoint in meeting the goals of this specification. These goals are:
The priority levels are assigned as follows:
Some checkpoints that refer to generating, authoring, or checking Web content have multiple priorities. The priority depends on the corresponding priority in the Web Content Accessibility Guidelines (WCAG) 1.0 [WCAG10].
For example:
When a checkpoint in this document refers to the WCAG 1.0 [WCAG10], only the WCAG 1.0 checkpoints that refer to content supported or automatically generated by the authoring tool apply. Some of the applicable WCAG 1.0 checkpoints may be satisfied automatically (without author participation) while others require human judgment and support from the tool in the form of prompts and documentation. Different tools may satisfy the same checkpoint differently.
The priority level for each checkpoint has been chosen based on the assumption that the author is a competent, but not necessarily expert, user of the authoring tool, and that the author has little or no knowledge of accessibility. For example, the author is not expected to have read all of the documentation, but is expected to know how to turn to the documentation for assistance.
This section explains how to make a valid claim that an authoring tool conforms to this document. Anyone may make a claim (e.g., vendors about their own products, third parties about those products, journalists about products, etc.). Claims may be published anywhere (e.g., on the Web or in product documentation).
The conformance icons provided for Authoring Tool Accessibility Guidelines 1.0 are not valid for expressing conformance to this draft
A conformance claim must indicate what conformance level is met:
Note: Conformance levels are spelled out in text (e.g., "Double-A" rather than "AA") so they may be understood when rendered as speech.
A well-formed claim must include the following information:
This information may be provided in text or metadata markup (e.g., using the Resource Description Framework (RDF) [RDF10] and an RDF schema designed for WAI conformance claims). All content in a claim provided other than as metadata must be accessible according to the Web Content Accessibility Guidelines 1.0 [WCAG10].
Here is an example of a claim expressed in HTML:
<p>MyAuthoringTool version 2.3 on MyOperatingSystem conforms to <abbr title="the World Wide Web Consortium">W3C</abbr>'s "Authoring Tool Accessibility Guidelines "wombat" Working Group Internal Draft, 22 June 2001", available at http://www.w3.org/WAI/AU/wombat/010622, level Double-A. Details of this claim are provided at <a href="http://example.com/details"> http://example.com/details</a>.</p>
A conformance claim is valid for a given conformance level if:
Claimants (or relevant assuring parties) are responsible for the validity of a claim. As of the publication of this document, W3C does not act as an assuring party, but it may do so in the future, or establish recommendations for assuring parties.
Claimants are expected to modify or retract a claim if it may be demonstrated that the claim is not valid. Please note that it is not currently possible to validate claims completely automatically.
There are currently no conformance icons available for this draft specification. If it becomes a recommendation it is expected that there will be conformance icons like those available for Authoring Tool Accessibility Guidelines 1.0.
If the tool automatically generates markup, many authors will be unaware of the accessibility status of the final content unless they expend extra effort to review it and make appropriate corrections by hand. Since many authors are unfamiliar with accessibility, authoring tools are responsible for automatically generating accessible markup, and where appropriate, for guiding 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 specifically intended for the Web such as HTML. Markup changes may also be made to facilitate efficient editing and manipulation. It is essential that these processes do not introduce inaccessible markup or remove accessibility content, particularly when a tool hides the markup changes from the author's view.
Rationale: this is a basic requirement to allow the author to create accessible content within the tool.
At minimum (required basic functionality): the author can add or edit any elements or element properties of the language that can enhance accessibility.
More advanced (optional suggested functionality): provide an integrated interface to properties affecting accessibility (see also )
See also: checkpoint 7.2,
At minimum (required basic functionality):Accessibility content must be preserved. Where sufficient structure information to allow reversal of the transformation is not preserved, the author must be notified that the transformation cannot be reversed accessibly. [@@issue 1: this requirement is still under discussion]
Optional advanced implementation: use markup, or some other mechanism to record the transformation and ensure reversibility.
Note this checkpoint covers importing from a format the tool does not use.
See also
At minimum templates, clip art, scripts, applets, example pages, etc supplied with the tool must conform to WCAG 1 (to the conformance level claimed by the tool)
See also
More advanced implementations may integrate this with the checking and repair functions of guideline 4, allowing the author finer-grained control.
Note: The author may have included or imported markup that enhances accessibility but is not recognized by the tool.
Conformance with standards promotes interoperability and accessibility by making it easier to create specialized user agents that address the needs of users with disabilities. In particular, many assistive technologies used with browsers and multimedia players are only able to provide access to Web documents that use valid markup. Therefore, valid markup is an essential aspect of authoring tool 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.
More advanced: Provide a mechanism for importing new language definitions
Rationale: W3C specifications have undergone review specifically to ensure that they do not compromise accessibility, and where possible, they enhance it.
See also:
Rationale: This is necessary for user agents to be able to render Web content in a manner appropriate to a particular user's needs.
See also:
Well-structured information and equivalent alternative information are cornerstones 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. Yet producing equivalent information, such as text alternatives for images and auditory descriptions of video, can be one of the most challenging aspects of Web design, and authoring tool developers should attempt to facilitate and automate the mechanics of this process. For example, prompting authors to include equivalent alternative information such as text equivalents, captions, and auditory descriptions at appropriate times can greatly ease the burden for authors. Where such information can be mechanically determined and offered as a choice for the author (e.g., the function of icons in an automatically-generated navigation bar, or expansion of acronyms from a dictionary), the tool can assist the author. At the same time, the tool can reinforce the need for such information and the author's role in ensuring that it is used appropriately in each instance.
Rationale:This checkpoint requires authoring tools to ask for (and support the creation of) alternate text, captions, auditory descriptions, collated text transcripts for video, etc. at times appropriate to the author-tool interaction.
Note: Some checkpoints in the Web Content Accessibility Guidelines 1.0 [WCAG10] do not apply. [@@issue 5: identify which checkpoints apply]
More advanced implementations might provide special authoring facilities that automate some of the process of generating alternative information (ex. voice recognition to produce collated text transcripts).
See also: Checkpoint 3.4,
Note: Some checkpoints in Web Content Accessibility Guidelines 1.0 [WCAG10] do not apply. [@@issue 6: identify which ones]
At minimum basic required functionality: Usually, when a new object is inserted, the function is unknown, so the tool should prompt the author to enter an appropriate equivalent alternative without providing a generated default entry (e.g. the file name and size). However, alternatives may be automatically generated or re-used when the tool has either placed the object for a specific purpose (e.g. navigation bar) or the user has defined a purpose for the object. Only an alternative that has been explicitly associated with an object may be offered as a default entry for the author to approve.
See also: checkpoint 1.4 and checkpoint 3.4,
Rationale: Compliance with checkpoint 3.3 may be simplified by providing an alternative equivalent management system.
At minimum: store associations between the multimedia objects and alternatives created by the author, allowing the author to edit the alternatives and reuse them easily.
More advanced implementations might collect alternatives from a variety of sources (the author, prepackaged, the Web) and provide powerful tools for managing the associations, including search functions and object similarity estimates.
See also:
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 can (where possible, automatically) identify inaccessible markup, and enable its correction even when the markup itself is hidden from the author.
Authoring tool support for the creation of accessible Web content should account for different authoring styles. Authors who can configure the tool's accessibility features to support their regular work patterns are more likely to accept accessible authoring practices (refer to guideline 5). For example, some authors may prefer to be alerted to accessibility problems when they occur, whereas others may prefer to perform a check at the end of an editing session. This is analogous to programming environments that allow users to decide whether to check for correct code during editing or at compilation.
Note: Validation of markup is an essential aspect of checking the accessibility of content.
Rationale: provide the author with a utility that helps check documents for accessibility problems.
More advanced implementation: the checks should be automated to the greatest extent possible.
See also:
At a minimum, provide context-sensitive help with the accessibility checking required by checkpoint 4.1.
Advanced implementations: provide the author with automated or semi-automated correction tools, in addition to guidelines and examples.
See also: checkpoint 4.1
At minimum (required basic functionality): provide a list of the problems by type.
Advanced implementations might integrate the summary with the tool's repair functionality to increase the flexibility with which problems can be corrected (see checkpoint 4.2).
See also:
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 software stability can be factors affecting author acceptance of the new feature. In addition, the relative prominence of different ways to accomplish the same task can influence which one the author chooses. Therefore, it is important that creating accessible content be a natural process when using an authoring tool.
Minimum (required basic functionality): The user interface component to initiate the function must be a visible part of the main user interface
More advanced (suggested): Allow the user to configure this to happen on a schedule or at user request
See also: checkpoints 3.1, 3.2, 4.1, 4.2 Techniques for checkpoint 5.2
Rationale: that accessibility-related functionality be integrated as seamlessly as possible.
At minimum, the accessibility features should not contrast with the normal operation of the tool. This means that they should be operable with approximately the same number of mouse clicks or keystrokes, the same amount of instruction, and the same degree of flexibility as other features.
For example, if an element's properties are displayed in a floating toolbar, accessibility-related prompts should be added to this toolbar, not implemented as intrusive pop-up boxes.
More advanced implementations might see accessibility features such as checking, integrated to the same level as analogous features unrelated to accessibility.
For example, if underlining or color changes are used to notify the author, while they work, of syntax and spelling errors, accessibility problems should be similarly flagged.
At minimum, when there is an accessible and a less accessible means for performing an action, the user interface of the tool should be organized so that the accessible means is at least as visible in the user interface and at least as easy to activate in terms of mouse clicks and keystrokes than the less accessible means.
More advanced solutions might purposefully impede the visibility and use of the less accessible means.
See also:
At minimum (required basic functionality): all documented examples of the authoring tool interface (i.e. dialog boxes, code views, etc.) should include any relevant accessible authoring practices.
See also:
Web authors may not be familiar with accessibility issues that arise when creating Web content. Therefore, help and documentation must include explanations of accessibility problems, and should demonstrate solutions with examples.
At minimum (required basic functionality): Document the purpose and use of all features of the tool that help create accessible content.
More advanced implementations Provide context-sensitive links to this documentation from the actual features, within the authoring tool user interface. Also provide a dedicated "Accessibility" section of the documentation for this material.
See also: checkpoint 5.4,
At minimum (required basic functionality): Document the techniques required to meet all WCAG checkpoints at the relevant priority level - (these may include work-around methods where the tool does not yet have the appropriate functionality).
Optional advanced functionality: Automating the process of producing accessible content will mean that nothing special needs to be done to meet this checkpoint. But providing context-sensitive linking to this documentation may be an intermediary development strategy.
See also:
The authoring tool is a software program with standard user interface elements and as such must be designed according to relevant user interface accessibility guidelines. When custom interface components are created, it is essential that they be accessible through the standard access mechanisms for the relevant platform so that assistive technologies can be used with them.
Some additional user interface design considerations apply specifically to Web authoring tools. For instance, authoring tools must ensure that the author can edit (in an editing view) using one set of stylistic preferences and publish using different styles. Authors with low vision may need large text when editing but want to publish with a smaller default text size. The style preferences of the editing view must not affect the markup of the published document.
Authoring tools must also ensure that the author can navigate a document efficiently while editing, regardless of disability. Authors who use screen readers, refreshable braille displays, or screen magnifiers can make limited use (if at all) of graphical artifacts that communicate the structure of the document and act as signposts when traversing it. Authors who cannot use a mouse (e.g., people with physical disabilities or who are blind) must use the slow and tiring process of moving one step at a time through the document to access the desired content, unless more efficient navigation methods are available. Authoring tools should therefore provide an editing view that conveys a sense of the overall structure and allows structured navigation.
Note: Documentation, help files, and installation are part of the software and need to be available in an accessible form.
See also:
At minimum (required basic functionality): provide at least one accessible way to edit every element and object property supported by the tool.
More advanced implementations might ensure that all of the ways in which the tool allows element and object properties to be edited should be accessible.
See also
At minimum (required basic functionality): the checkpoint requires that the author be able to copy, cut or paste an element and its content at any level of the document tree hierarchy.
More advanced implementations might provide more powerful ways to edit elements or groups of elements in the structure.
See also:
At minimum there must be some mechanism for changing the document display independently of the document markup.
There are a number of ways that this can be achieved, including supporting operating environment display preferences and allowing the author to specify an editing style sheet that is different from those included with the end document. In addition, there must be some means by which textual alternatives can be displayed to the author in place of non-text elements. [@@issue 8 - need to clean this paragraph up - some is techniques, plus wording and some is useful for the checkpoint]
See also:
At minimum, the author should be able to move from element to element. [@@issue 9: is this actually what we need?]
More advanced implementations might provide highly flexible mechanisms that take advantage of the hierarchical nature of the document tree.
See also:
At minimum, the tool should allow basic text search with a choice of skipping or including markup
More advanced implementations might have more powerful mechanisms that, for example, can search on the basis of structure or similarity.
See also:
"alt"
,
"title"
, and "longdesc"
attributes in
HTML).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 entry.BLOCKQUOTE
element in HTML [HTML4] to achieve an indentation
visual layout effect. Structural markup should be used correctly to
communicate the roles of the elements of the content and presentation markup should be used
separately to control the presentation and layout.Many thanks to the following people who have contributed through review and comment: Giorgio Brajnik, Daniel Dardailler, Katie Haritos-Shea, Phill Jenkins, Len Kasday, Marjolein Katsma, William Loughborough, Matthias Müller-Prove, Graham Oliver, Chris Ridpath, Gregory Rosmaita, Heather Swayne, Carlos Velasco.
This document would not have been possible without the work of those who contributed to The Authoring Tool Accessibility Guidelines 1.0
For the latest version of any W3C specification please consult the list of W3C Technical Reports at http://www.w3.org/TR.