Contents | Part A | Part B | References
Copyright ©2005 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C liability, trademark and document use rules apply.
Applicability: This success criteria is only applicable to authoring tools that choose the content type for authoring.
Technique B.1.1-1.1 [Sufficient]: Providing a content type-specific WCAG benchmark (referenced in the ATAG 2.0 conformance profile) for all content types that are automatically chosen, either because a content type is the only one that is supported for a given task or because a shortcut is provided that allows new content to be created with a minimum of steps.
Applicability: This success criteria is only applicable to authoring tools that let the author choose the content type for authoring.
Technique B.1.1-2.1 [Sufficient] : Whenever the author is given the option to choose a content type, providing at least one of the content types has had a content type-specific WCAG benchmark (referenced in the ATAG 2.0 conformance profile). Also, giving prominence in the user interface (i.e., listed ahead of other content types, listed on the first page of choices, etc.) to content types with benchmark documents.
Technique B.1.1-2.2 [Advisory]: Displaying a warning when the author chooses to create Web content with a content type that lacks a content type-specific WCAG benchmark (in the ATAG 2.0 conformance profile).
Example B.1.1-2.2: A given tool displays a dialog box with a list of content type options. If the author selects a content type that lacks a content type-specific WCAG benchmark (in the ATAG 2.0 conformance profile), a status line displays the following text: "Accessibility support is not available for documents in the format". If the author activates, the option the same warning occurs in a dialog box and the author must indicate "OK" to proceed.
Applicability: Techniques in this section are not necessarily applicable to any one success criteria, and may apply more generally to the checkpoint as a whole.
Technique B.1.1-G.1 [Advisory]: Consulting content type-specific WCAG benchmark in ATAG 2.0 for guidance on how to create a benchmark document for a content type that does not already have one.
Technique B.1.1-G.2 [Advisory]: Supporting W3C Recommendations, which are reviewed for accessibility, wherever appropriate. References include:
- Technical Reports and Publications page of the W3C.
- W3C language specific accessibility notes: CSS [CSS2-ACCESS], SMIL [SMIL-ACCESS], HTML4 [HTML4-ACCESS], SVG [SVG-ACCESS], XML languages [XMLGL].
Technique B.1.1-G.3 [Advisory]: For tools that dynamically generate Web content, using HTTP content negotiation to deliver content in the preferred content type of the end-user.
Applicability: This success criteria is only applicable to authoring tools that perform either transformations or conversions.
Technique B.1.2-1.1 [Sufficient for (a)] : Ensuring that after transformations and conversions, any accessibility information that was stored in the original content is present in the resulting content, in such a way that the resulting content is available to end users (e.g. is rendered, is available to assistive technologies, etc.).
Technique B.1.2-1.2 [Sufficient for (b)]: Ensuring that when a transformation or conversion is to be performed that cannot be performed while preserving accessibility information, the author is warned that accessibility information (if any exists) will be lost and is given the option of allowing the tool to proceed to create the resulting content while saving a backup copy of the original content or preserving the original content markup by canceling the transformations and conversion.
Technique B.1.2-1.3 [Advisory]: Implementing best practices for transformation and conversion, such as:
- Allow authors to edit transformation or conversion templates to specify the way presentation conventions should be converted into structural markup.
- Ensure that changes to graphical layouts do not reduce readability when the document is rendered serially. For example, confirm the linearized reading order with the author.
- Avoid transforming text into images. Use style sheets for presentation control, or use an XML application (e.g., SVG [SVG]) that keeps the text as text. If this is not possible, ensure that the text is available as equivalent text for the image.
- When importing images with associated descriptions into a markup document, make the descriptions available through appropriate markup.
- When transforming a table to a list or list of lists, ensure that table headings are transformed into headings and that summary or caption information is retained as rendered content.
- When converting linked elements (i.e., footnotes, endnotes, call-outs, annotations, references, etc.) provide them as inline content or maintain two-way linking.
- When converting from an unstructured word-processor format to markup, ensure that headings and list items are transformed into appropriate structural markup (appropriate level of heading or type of list, etc.).
- When developing automatic text translation functions, strive to make the resulting text as clear and simplest as possible.
Technique B.1.2-1.4 [Advisory]: Notifying the author before changing the content type (including the DTD).
Technique B.1.2-1.5 [Advisory]: Providing the author with explanations of automatic changes made during transformations and conversions.
Applicability: This success criteria is only applicable to authoring tools that are capable of automatically removing content.
Technique B.1.3-1.1[Sufficient]: When an automatic process is to be performed that cannot be completed without removing content (even including unrecognized markup), providing the author with the option of allowing the tool to remove the markup and proceed with the operation or preserving the markup by canceling the operation.
Technique B.1.3-1.2 [Advisory]: Providing the author the option to confirm or override removal of content either on a change-by-change basis or as a batch process.
Applicability: This success criteria is only applicable to authoring tools that automatically generate some amount of content, including markup.
Technique B.1.4-1.1 [Sufficient]: Ensuring that any action that the authoring tool takes alone that causes content to be added or modified has the result of not introducing new contraventions of the content type-specific WCAG benchmark. Contravening actions are allowed when they are specifically requested by the author (e.g., they choose to insert a specific element by name from a list) or when the author has failed to properly comply with an information request that would have prevented the contravention (e.g., ignored a short text label prompt for an image).
Technique B.1.4-1.2 [Advisory]: Using prompting to elicit information from the author when necessary (see Checkpoint B.2.1).
Technique B.1.4-1.3 [Advisory]: Ensuring that any mechanisms involved in the automatic generation processes result in content that meet the content type-specific WCAG benchmark (see Checkpoint B.1.5).
Applicability: This success criteria is not applicable to authoring tools that do not bundle or preferentially license pre-authored content.
Technique B.1.5-1.1 [Sufficient]:ensuring that any Web content that is bundled with the authoring tool (e.g., on the installation media) or preferentially licensed to the users of the authoring tool (i.e., provided for free or sold at a discount), meets the content type-specific WCAG benchmark.
Technique B.1.5-1.2 [Advisory]: Authoring Web content to be bundled using ATAG 2.0 conformant authoring tools and ensuring it passes accessibility checks.
Technique B.1.5-1.3 [Advisory] : Providing pre-authored graphical content in content types that allow for accessible annotation to be included in the files, such as SMIL [SMIL], PNG [PNG], and SVG [SVG].
Technique B.1.5-1.4 [Advisory]: Ensuring that equivalent alternatives provided for pre-authored content are usable compatible with features to manage, editing, and reusing equivalent alternatives (see Checkpoint B.2.5).
Example B.1.5-1.4: A given tool is shipped with a clip art collection. Each image in the collection has a short text label and long text description and the associations have all been pre-loaded into the equivalent alternative management system so that whenever the author inserts an image it's equivalent alternatives are automatically retrieved.
Applicability: This success criteria is applicable to all authoring tools.
Technique B.2.1-1.1 [Sufficient]: Ensuring that, whenever content that requires accessibility information from the author in order to agree with the content type-specific WCAG benchmark is added/updated, the author is informed of the need for the additional information by prompting mechanisms and assisting mechanisms that are appropriate for the type of information in question (see Prompting for Various Types of Accessibility Information).
Technique B.2.1-1.2 [Advisory]: Checking all textual entries for spelling, grammar, and reading level (where applicable).
Technique B.2.1-1.3 [Advisory]: Providing multiple preview modes and a warning to authors that there are many other less predictable ways in which a page may be presented (aurally, text-only, text with pictures separately, on a small screen, on a large screen, etc.). Some possible document views include:
- an alternative content view (with images and other multimedia replace by any alternative content)
- a monochrome view (to test contrast)
- a collapsible structure-only view
- no scripts view
- no frames view
- no style sheet view
Example B.2.1-1.3: This illustration shows a WYSIWYG authoring interface with a list of rendering options displayed a sub-menu options in a View menu. The options include "All" (i.e., render as in a generic browser), "text-only" (i.e., non-text items replaced by textual equivalents), "no styles", "no frames", and "grayscale" (used to check for sufficient contrast). In the background, the "earthrise" image in the WYSIWYG view can be seen in grayscale. (Source: mockup by AUWG)
This list is meant to cover techniques of prompting and assisting for many, but not all, of the most common accessible authoring practices:
(1): Prompting and assisting for short text labels (e.g., alternate text, titles, short text metadata fields, rubies for ideograms):
- (a) Prompts for short text strings may be afforded relatively little screen real estate because they are usually intended to elicit entries of ten words or less.
- (b) Provide a rendered view of the object for the author to examine while composing the label.
- (c) Implement automated routines to detect and offer labels for objects serving special functions (e.g., "decorative", "button", "spacer", "horizontal rule", etc.).
- (d) Use editable text entry boxes with drop-down lists that let the author add new text and also assist the author by providing the option to select from reusable or special function label text, as describe in (c) (see Example (1a)).
- (e) In code-based tools, prompt the author with short text labels that are already marked up appropriately (see Example (1b)).
Example (1a): This illustration shows a dialog box for offering short text labels for reuse. It shows an "Insert Image" dialog box a thumbnail image of the "earthrise" graphic along with entry fields for
src
,alt
,longdesc
,height
andwidth
. Thealt
entry field is drop-down list that is shown with several short labels for the same image. The first is a visual description in English ("An earth rise as seen from the moon"), the second is a visual description in French ("Une vue do la terre de la lune") and the third is an English functional label used if the image serves as a link ("Go to pictures of the earth"). (Source: mockup by AUWG)
Example (1b): This illustration shows a code-based authoring interface for offering short text labels for reuse. It shows the author midway through adding markup for an image. After adding the
src
attribute value the author has pressed the spacebar, causing the tool to prompt them with thealt
attribute along with several attribute values, including a visual description in English (alt="An earth rise as seen from the moon"), a visual description in French (alt="Une vue do la terre de la lune") and an English functional label used if the image serves as a link (alt="Go to pictures of the earth"). (Source: mockup by AUWG)
(2): Prompting and assisting for multiple text labels (e.g., image map area labels):
- (a) Prompts for image map text labels may be similar to those for short text labels with allowance made for rapidly adding several labels for one image map. (see Example (2))
- (b) Provide a preview of the image map areas.
- (c) Provide the URI of image map areas as a hint for the labels.
- (d) Offer to automatically generate a set of plain text links from the labels that the user completes. (see Example (2))
Example (2): This illustration shows an authoring interface for image map area text label prompting. It is comprised of a list with two columns. In the right-hand column is the URL for each image map area. This can be used as a hint by the author as they fill in the text labels (left-hand column). A checkbox at the bottom provides the option of using the text labels to create a set of text links below the image map. (Source: mockup by AUWG)
(3): Prompting and assisting for long text descriptions (e.g., longdesc text, table summaries, site information, long text metadata fields):
- (a) Begin by prompting the author about whether the inserted object is adequately described with an existing short text label. Providing a view of the page with images turned off may help the author decide. (see Example (3))
- (b) If the short description is inadequate, prompt the author for the location of a pre-existing description.
- (c) If the author needs to create a description, provide a special writing utility that includes a rendered view of the object and description writing advice.
- (d) Implement automated routines that detect and ignore some objects that do not require long text descriptions (e.g., bullets, spacers, horizontal rules).
Example (3): This illustration shows an authoring interface for long text description prompting. A "description required" checkbox controls whether the rest of the interface is available. If a description is required, the author then has the choice of opening an existing description file or writing (and saving) a new one. If they choose to use an existing file, there is a text entry area for the name along with a button to browse the file system. If they choose to compose a new description, there is a text entry area for the description followed by a text field for the file name and a button to save it to that location. In the situation shown, the author chooses to use an existing description of "earthrise" so the file name containing the description is shown. In addition, the text of the description from the file is loaded into the compose area ("The earth hangs in the pitch black sky above the gray horizon of the moon. The dazzling blue sphere is covered with creamy white streamers of cloud.") in case the author would like to use this text as a basis for a new description. (Source: mockup by AUWG)
(4): Prompting and assisting for form field labels:
- (a) Present the form fields and ask the author to select text that is serving as a label or to enter a new label. (see Example (4))
- (b) Alert authors to form fields that are missing labels.
Example (4): This illustration shows a form properties list with five columns that allows the author to simultaneously decide the following for each field: the tab order, form name, field label, control type, and accesskey. In this example, two form field labels are missing, causing prompts (yellow highlighting of the cells and red icons) to be displayed. "Move up" and "move down" buttons are provided. (Source: mockup by AUWG)
(5): Prompting and assisting for form field place-holders:
- (a) Prompts for form field place-holders may be similar to those for short text labels.
- (b) Provide authors with the option of directly selecting nearby text strings that are serving implicitly as labels.
(6): Prompting and assisting for TAB order sequence:
- (a) Provide the author with a numbering tool that they can use to select controls to create a TAB preferred sequence. (see Example (6))
- (b) Where there are only a few links that change in each page of a collection, ask the author to confirm whether these links receive focus first. If so, then the tool can appropriately update the tabindex order.
- (c) Provide a list of links and controls to check the TAB order.
Example (6): This illustration shows two views of a "Set TAB Order" utility that lets the author visualize and adjust the TAB order of a document: the first is a mouse-driven graphical overlay on the screen and the second is a keyboard accessible version. In the mouse-driven version, small white-on-red numbers are displayed on the WYSIWYG view, denoting the order. In the keyboard-accessible version, the focusable objects are listed in a list with three columns: position in the TAB order, the control name or label, and the control type. "Move up" and "move down" buttons are provided
(7): Prompting and assisting for navigational shortcuts (e.g., keyboard shortcuts, skip links, voice commands, etc.):
- (a) Prompt authors to add skip over navigation links for sets of common navigation links. (see Example (7a))
- (b) Prompt authors with a list of links that are candidates for accesskeys because they are common to a number of pages in a site.
- (c) Manage accesskey lists to ensure consistency across sites and to prevent conflicts within pages.(see Example (7b))
Example (7a): This illustration shows a WYSIWYG mechanism that detects repeating navigation elements and asks the author whether they want to add a skip navigation link. The WYSIWYG editing view shows the author working on a page that is part of a site called "AstroNet". The page has a navigation bar at the top that includes links to the AstroNet home page, "Mercury", "Venus", "Earth", "Mars" and "Jupiter". The entire navigation bar has been highlighted with a blue box. The author has right-clicked on this box to display a pop-up menu with the following accessibility-related choices: "Repair: Add 'skip over navigation' link", "Skip", "Ignore", "Check Accessibility...", and "Help...". (Source: mockup by AUWG)
Example (7b): This illustration shows a code level authoring interface that suggests access key values. The following markup can be seen: "
<body><p>Here is one of the most famous photographs taken from the <a href="moon.html" > moon.</a></p><It was taken with a special <a href=camera.html" accesskey="c">camera.</p>"
. A pop-up menu, centered on the word "moon" suggest accesskey="moon", because "moon" begins with "m", followed by the rest of the alphabet in order. Accesskey="c" is missing, however, since it is already used as an accesskey later in the document (for the "camera" link). (Source: mockup by AUWG)
(8): Prompting and assisting for contrasting colors:
- (a) Assemble color palettes with insufficiently contrasting colors excluded (see Example (8)) or identified.
- (b) Provide gray scale and black and white views or suggest the author activate the system operating system high contrast mode.
- (c) Emphasize "Web-safe" colors.
Example (8): This illustration shows a dialog box for choosing a text color. The dialog box has two tabs: one for text color and one for background color. A "hide low contrast choices" checkbox has been selected , so the palette of colors has been pre-screened so that sufficient contrast between the text and the current background color is assured. All other colors have been grayed out. (Source: mockup by AUWG)
(9): Prompting and assisting for alternative resources for multimedia (transcripts, captions, video transcripts, audio descriptions, signed translations, still images, etc.):
- (a) Prompt the author for the location of a pre-existing alternative resources for multimedia (see Example (9)).
- (b) Although producing alternative resource for multimedia can be a complex process for long media files, production suites do exist or authoring tools can include simple utilities, with built-in media players, for producing simple alternative resources.
- (c) The tool should be able to access alternative resources for multimedia, which may be incorporated into existing media or exist separately.
Example (9): This illustration shows a dialog box for embedding a video. The tool shows a thumbnail of the video (in this case a nebula) and tabs for each type of text and synchronized alternative: captions, audio descriptions, signed translations and a still image. Each tab displays a red or green icon to indicate whether the alternative is available. In this case, the captioning tab pane is shown and this is split into two sections: embedded captions and external captions (SMIL). Both are marked as "not detected", however for the external captions, the author has the option of browsing their system to find the caption file, or launching an authoring utility to create a new caption file. (Source: mockup by AUWG)
(10): Prompting and assisting for Metadata:
- (a) For metadata information fields requiring information similar to that discussed in the other sections of this technique, see the relevant section. For example: short text labels ((1)), long text descriptions ((3)), and alternative resources for multimedia((9)).
- (b) When prompting for terms in a controlled vocabulary, allow the author to choose from lists to prevent spelling errors.
- (c) Provide the option of automating the insertion of information that easily stored and reused (e.g., author name, author organization, date, etc.).
- (d) Automate metadata discovery where possible.
- (e) Provide the option of storing licensing conditions within metadata. (see, for example, the Creative Commons licenses [CREATIVE-COMMONS], or the GPL [GPL], LGPL [LGPL], BSD [BSD], and other software licenses)
- (f) Consider characterizing accessibility of content using IMS AccessForAll Meta-data Specification [IMS-ACCMD]<http://www.imsproject.org/accessibility/index.cfm#version1pd> to facilitate personalized content delivery.
(11): Prompting and assisting for document structure:
- (a) Alert the author to the occurrence of unstructured content in a way that is appropriate to the workflow of the tool.
- (b) Provide the author with options for creating new content that is structured, such as:
- templates (with pre-defined structure),
- wizards (that introduce structure to content through a series of system-generated queries), or
- real time validators (that may be set by the author to prevent the creation of improperly structured content)
- (c) Provide the author with options for imposing structure on existing unstructured content.
- For tools that support explicit structural mechanisms offer authors the opportunity to use those mechanisms. For example, for DTD or schema based structures, provide validation in accordance to the applicable DTD or schema.
- For tools that do not support explicit structural mechanisms, offer authors the option of deriving structure from format styles. For example, provide authors a mechanism to map presentation markup that follows formatting conventions into structural elements. For example, patterns of text formatting may be interpreted as headings (see Example (11)) and multiple lines of text beginning items with certain typographical symbols, such as "*" or "-", may be interpreted as list items.
- (d) Provide structure-based editing features, such as:
- hide/show content blocks according to structure,
- shift content blocks up, down, and sideways through the document structure, or
- hierarchical representation or network diagram view of the document structure, as appropriate.
- (e) Provide fully automated checking (validation) for structure.
- (f) Provide fully automated or semi-automated repair for structure.
- (g) It is not necessary to prohibit editing in an unstructured mode. However, the tool should alert authors to the fact that they are working in an unstructured mode.
Example (11): This illustration shows a WYSIWYG authoring tool that detects opportunities for enhancing structure and alerts the author. On the left side is the WYSIWYG editing view with the title of the page ("Mars") displayed with a blue underline. The author has brought up a pop-up menu for the title and sees the following options: "Repair: Mark as heading (a sub-menu displays the different levels of header (i.e., h1, h2, etc.)) for the author to choose", "Skip", "Ignore", "Check Accessibility...", and "Help...". On the right, an element inspector makes clear that the title is currently marked up as a paragraph. (Source: mockup by AUWG)
(12): Prompting and assisting for tabular structure:
- (a) Prompt the author to identify tables as used for layout or data or implement automated detection mechanisms.
- (b) Differentiate utilities for table structure from utilities for document layout - use this when tables are identified as being for layout.
- (c) Prompt the author to provide header information.(see Example (12))
- (d) Prompt the author to group and split columns, rows, or blocks of cells that are related.
- (e) Provide the author with a linearized view of tables (as tablin does).
Example (12): This illustration shows a WYSIWYG authoring tool that prompts the author to decide whether the top row of a table are the table headers. The top row of the rendered table is outlined in blue to indicate an accessibility problem. The author has brought up a pop-up menu for one of the cells in the top row and sees the following options: "Repair: Set as header row", "Skip", "Ignore", "Check Accessibility...", and "Help...". (Source: mockup by AUWG)
(13): Prompting and assisting for style sheets:
- (a) Use style sheets, according to specification, as the default mechanism for presentation formatting and layout.
- (b) If content is created with a style sheet format, along with a content format, the use of that style format must also meet the requirements of WCAG.
- (c) Conceal the technical details of style sheet usage to a similar degree as for usage of other markup formats supported by the tool.
- (d) Assist the author by detecting structural markup (e.g., header tags, etc.) that has been misused to achieve presentation formatting and, with author permission, transforming it to use style sheets. (see Example (13a))
- (e) Prompt the author to create style classes and rules within and across document, rather than using more limited in-line styling.
- (f) Assist the author by recognizing patterns in style sheet use and converting them into style classes and rules.
- (g) Provide the option of editing text content independently of style sheet layout and presentation formatting. (see Example (13b))
- (h) Assist the author with the issue of style sheet browser compatibility by guiding them towards standard practices and detecting the existence of non-standard practices.
- (i) Assist the author by providing a style sheet validation function.
- (j) Maintain a registry of styles for ease of re-use.
- (k) For prompting and assisting with specific types of information required by style sheets, see the other sections in this technique. For example: font/background colors (see (8)) and document structure (see (12)).
- (l) Consult the following references: Accessibility Features of CSS [CSS Access], CSS2.1 specification [CSS21], and XML Accessibility Guidelines [XML Access].
Example (13): This illustration shows a WYSIWYG authoring tool that indicates to the author that a heading has been misused to indicate emphasis. In the WYSIWYG editing view, some text ("VERY HOT") is rendered large and bold because it has been improperly marked as a heading and it is therefore marked with a blue underline as an accessibility problem. The author has brought up a pop-up menu for the text and sees the following options: "Repair: Mark with style (a sub-menu displays the different styles available (i.e., .bodytext, .quotetext, .hot_emphasis, .cold_emphasis))", "Skip", "Ignore", "Check Accessibility...", and "Help...". (Source: mockup by AUWG).
(14): Prompting and assisting for clearly written text:
- (a) Prompt the author to specify a default language of a document.
- (b) Provide a thesaurus function.
- (c) Provide a dictionary lookup system that can recognize changes of language, terms outside a controlled vocabulary as well as known abbreviation or acronym expansions.
- (d) Provide an automated reading level status. (see Example (14a))
- (e) Prompt the author for expansions of unknown acronyms, recognizable in some languages as collections of uppercase letters. (see Example (14b))
Example (14a): This illustration shows a code level authoring interface that indicates the reading level of a page and whether it exceeds a limit determined by the author's preference settings. The code view includes the following markup:
<body><h1>Mars</h1><p>Mars is the fourth planet in the solar system, orbiting at a distance of 1.5 AU, with a period of 687 days.</p></body></html>
. Then in a status bar below the text entry area, is a reading level display: "Reading Level: 11.2 (target<8)". The 11.2 is highlighted with a yellow background and bold text to indicate that the target is exceeded. (Source: mockup by AUWG)
Example (14b): This illustration shows an authoring interface that prompts the author to enter an acronym expansion. The rendered text reads: "The 'habitable zone' around a star is the region of that star’s solar system in which liquid water is possible. The continuous habitable zone (CHZ) is the a region of the solar system which has remained in the zone, even during changes in the star’s radiation pattern." The acronym "CHZ" is identified with a blue underline as an accessibility problem. The author has brought up a pop-up menu for the acronym and sees the following options: "Repair: Enter acronym expansion…", "Check Accessibility...", and "Help...". (Source: mockup by AUWG)
(15): Prompting and assisting for device independent handlers:
- (a) During code development, prompt the author to include device-independent means of activation.
- (b) Prompt authors to use device-independent events (e.g., DOM 2
onactivate
[DOM]) instead of device-specific events (e.g.,onclick
), or route multiple events (onclick
andonkeypress
) through the same functions.- (c) Prompt authors to add a DOM
onfocus
event to elements that are targeted with theonmouseover
event.- (d) Prompt authors about using events for which no common device-independent analogue exists (e.g.,
ondblclick
) and avoid these events as default options.(16): Prompting and assisting for non-text supplements to text:
- (a) Prompt the author to provide icons for buttons, illustrations for text, graphs for numeric comparisons, etc. (see Example (16))
- (b) Where subject metadata is available, look up appropriate illustrations.
- (c) If the author has identified content as instructions then provide templates or automated utilities for extracting flow charts, etc.
Example (16): This illustration shows an authoring interface for prompting the author about whether a paragraph that contains many numbers might be made more clear with the addition of a chart or graph. On the left side of the interface is the rendered text: " Planet Orbits: The inner planets orbit the sun relatively quickly with Mercury orbiting the sun in 88 days, Venus in 224 days, Earth in 365 days, and Mars in 687 days. Compare this to Jupiter’s, 4332 day orbit. "This text is marked with an yellow, exclamation mark icon. On the right side is an explanation of the error icon: "This paragraph contains 5 numbers. Would readers benefit if a chart or graph of this information was added?". "Yes" and "no" buttons are provided. (Source: mockup by AUWG)
(17): Prompting and assisting the author to make use of up-to-date content types:
- (a) Default to the most up-to-date content types available whenever the author has not specified a content type.
- (b) Give up-to-date content types a higher prominence during content type selection.
- (c) Provide tools that convert content in older content types into more up to date ones.
- (d) Fully or partially automate some of the more complex aspects of more up to date content types, including document structure (see (11)) and use of style sheets (see (13)).
Applicability: This success criteria is applicable to all authoring tools.
Technique B.2.1-2.1 [Sufficient for (a)] : Remove any instruction text that, if followed exactly by the author, would lead to content being created or modified to disagree with the content type-specific WCAG benchmark.
Technique B.2.1-2.2 [Sufficient for (b)]: Consistently labeling help documents or other documentation that, if followed exactly by the author, would lead to content being created or modified to disagree with the content type-specific WCAG benchmark.
Implementation Notes:
Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.2-1.1 [Sufficient]: Providing at least one check for check for each requirement in the content type benchmark document (see Levels of Checking Automation).
img
), each element instance must be individually identified as potential accessibility problems. For checks that are relevant across multiple elements (e.g., consistent navigation) or apply to most or all elements (e.g., background color contrast, reading level), the entire span of elements must be identified as potential accessibility problems, up to the entire content if applicable.):Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.2-2.1 [Sufficient]: Identifying the entire span of elements covered by a potential accessibility problem.
Example B.2.2-2.1(a): A given code level tool displays errors in a separate pane by the line number of the first element in the span.
Example B.2.2-2.1(b): A given code level tool displays errors in-line by underlining all of the markup for the affected span of elements.
Example B.2.2-2.1(c): A given WYSIWYG tool displays errors in-line with the rendered content in the WYSIWYG editing view as blue outlining around or under the affected span of elements.
Technique B.2.2-2.2 [Advisory]: Displaying manual checks in a way that balances the need for the author to make specific changes to some kinds of content (e.g., non-text objects, acronyms, table cells, etc.) while not overwhelming the author with numerous manual checks for other kinds of content that can be checked more generally (e.g., background color contrast, reading level, etc.).
Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.2-3.1 [Sufficient]: The wording of author information prompts during checking for a potential problem supports author judgment by answering the following questions: "What part of the content should be examined?" and "What is be present or absent in the event that the problem exists?".
Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.2-4.1 [Sufficient]: Providing accessibility checking as an action (e.g., as a menu item, etc.) at all times.
Technique B.2.2-4.2 [Sufficient] : If accessibility checking is not always available as an action, prompting the author to perform an accessibility check if the author chooses to close or publish the content.
Applicability: Techniques in this section are not necessarily applicable to any one success criteria, and may apply more generally to the checkpoint as a whole.
Technique B.2.2-G.1 [Advisory]: Automating as much checking as possible. Where necessary provide semi-automated checking. Where neither of these options is reliable, provide manual checking (see Levels of Checking Automation).
Technique B.2.2-G.2 [Advisory]: Consulting the Techniques For Accessibility Evaluation and Repair Tools [WAI-ER @@change to AERT@@] Public Working Draft for evaluation and repair algorithms related to WCAG 1.0.
Technique B.2.2-G.3 [Advisory]: For certain types of programmatic content, enabling checking by rendering or executing the content as part of the checking process. This may apply to manual as well as automated or semi-automated checking processes.
Technique B.2.2-G.4 [Advisory]: For tools that allow authors to create their own templates, advising the author that templates should be held to a high accessibility standard, since they will be repeatedly reused. Enhancing this by making an accessibility checks mandatory before saving templates (see Checkpoint B.2.2).
This list is representative but not complete.
(a) Automated Checking: In automated checking, the tool is able to check for accessibility problems automatically, with no human intervention required. This type of check is usually appropriate for checks of a syntactic nature, such as the use of deprecated elements or a missing attribute, in which the meaning of text or images does not play a role.
Example of Automated Checking (1): This illustration shows a summary interface for a code-based authoring tool that displays the results of an automated check. The display is a tree-view where the leftmost nodes are the names of errors ("Image missing alternate text" and "Text boxes missing labels) with number of errors appended (e.g., "[6]") and the sub-items are the problem instances with line numbers appended (e.g., "(Line:45)"). (Source: mockup by AUWG)
Example of Automated Checking (2): This illustration shows a WYSIWYG interface that displays the results of an automated check in a WYSIWYG authoring view using blue highlighting around or under rendered elements (in this case, the "earthrise" image and some "blinking text"), identifying accessibility problems for the author to correct. (Source: mockup by AUWG)
Example of Automated Checking (3): This illustration shows an authoring interface of an automated check in a code-level authoring view. The text is: "
<body><p>Image:</p><img href="pic123.gif"/><hr/><blink>Blinking text</blink></body></html>
".In this view, the text of elements with accessibility problems (img
andblink
) is shown in a blue font, instead of the default black font. (Source: mockup by AUWG)
(b) Semi-Automated Checking: In semi-automated checking, the tool is able to identify potential problems, but still requires human judgment by the author to make a final decision on whether an actual problem exists. Semi-automated checks are usually most appropriate for problems that are semantic in nature, such as descriptions of non-text objects, as opposed to purely syntactic problems, such as missing attributes, that lend themselves more readily to full automation.
Example of Semi-Automated Checking: This illustration shows a dialog box that appears once the tool has detected an image without a description attribute. However, since not all images require description, the author is prompted to make the final decision ("Does this image require descriptive text?"). The author can confirm the at this is indeed an accessibility problem by choosing and move on to the repair stage by choosing "Yes" or press "No" to mark the potential problem, as not a problem at all. Additional help is available in the form of a tip: "An image requires descriptive text when the information it contains cannot be conveyed in 10 words or less using an alternate text label." (Source: mockup by AUWG)
(c) Manual Checking: In manual checking, the tool provides the author with instructions for detecting a problem, but does not automate the task of detecting the problem in any meaningful way. As a result, the author must decide on their own whether or not a problem exists. Manual checks are discouraged because they are prone to human error, especially when the type of problem in question may be easily detected by a more automated utility, such as an element missing a particular attribute.
Example of Manual Checking: This illustration shows a dialog box that reminds the author to check if there are any words in other languages in the document with the message: "Does this document contain any words or phrases in a different language than the main content?". The author can move on to the repair stage by pressing "Yes" or press "No" to mark the potential problem, as not a problem at all. (Source: mockup by AUWG)
Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.3-1.1 [Sufficient]: For each potential accessibility problem identified by the checking function (required in Checkpoint B.2.2), providing repair instructions that an author (with sufficient skill and knowledge to use the rest of the tool) could follow to correct the problem. At the developer's discretion, semi-automated repairs (that prompts the author for required information) or automated repairs (that are able to complete the repair without prompting the author) may be substituted.
Technique B.2.3-1.2 [Advisory]: Automating as much repairing as possible. Where necessary provide semi-automated repairing (see Levels of Repair Automation). Where neither of these options is reliable, provide manual repairing.
Technique B.2.3-1.3 [Advisory]: Implementing a special-purpose correcting interface where appropriate. When problems require some human judgment, the simplest solution is often to display the property editing mechanism for the offending element. This has the advantage that the author is already somewhat familiar with the interface. However, this practice suffers from the drawback that it does not necessarily focus the author's attention on the dialog control(s) that are relevant to the required correction. Another option is to display a special-purpose correction utility that includes only the input field(s) for the information currently required. A further advantage of this approach is that additional information and tips that the author may require in order to properly provide the requested information can be easily added. Notice that in the figure, a drop-down edit box has been used for the short text label field. This technique might be used to allow the author to select from text strings used previously for the alt-text of this image (see ATAG Checkpoint B.2.5).
Example B.2.3-1.3: This illustration shows a sample of a special-purpose correction interface. The tool supports the author's repair task by providing (1) a short description of the problem (here: "Missing Alternate Text Label for an Image"), (2) a preview (here: the "earthrise" image that is missing a label), (3) tips for performing the repair (here: "Alternate text should be 10 words or less and should include any text in the image."; "Image buttons should have alternate text that describes the button function."; and "Image bullets should have "bullet" as alternate text."), and (4) an offered semi-automated repair in an editable drop-down box (here: "An earth rise as seen from the moon"). (Source: mockup by AUWG)
Technique B.2.3-1.4 [Advisory]: Sequencing checks. In cases where there are likely to be many accessibility problems, it may be useful to implement a checking utility that presents accessibility problems and repair options in a sequential manner. This may take a form similar to a configuration wizard or a spell checker that performs checks in an order that is apparent to the author. In the case of a wizard, a complex interaction is broken down into a series of simple sequential steps that the author can complete one at a time. The later steps can then be updated "on-the-fly" to take into account the information provided by the author in earlier steps. A checker is a special case of a wizard in which the number of detected errors determines the number of steps. For example, word processors have checkers that display all the spelling problems one at a time in a standard template with places for the misspelled word, a list of suggested words, and "change to" word. The author also has correcting options, some of which can store responses to affect how the same situation can be handled later. In an accessibility problem checker, sequential prompting is an efficient way of correcting problems. However, because of the wide range of problems the checker needs to handle (i.e., missing text, missing structural information, improper use of color, etc.), the interface template will need to be even more flexible than that of a spell checker. Nevertheless, the template is still likely to include areas for identifying the problem (WYSIWYG or code-based according to the tool), suggesting multiple solutions, and choosing between or creating new solutions. In addition, the dialog may include context-sensitive instructive text to help the author with the current correction.
Example B.2.3-1.4: This illustration shows an example of a sequential accessibility checker, the special-purpose correction interface from Example B.2.3-1.3 is supplemented a progress indicator ("5 of 25") and with navigation buttons to move "back", "repair", "skip", get "help" and "cancel". and forwards through the list of repair tasks. (Source: mockup by AUWG)
Technique B.2.3-1.5 [Advisory]: Where an authoring tool is able to detect site-wide errors, allowing the author to make site-wide corrections. This should not be used for equivalent alternatives when the function is not known with certainty (see Checkpoint B.2.4).
Technique B.2.3-1.6 [Advisory]: Providing a mechanism for authors to navigate sequentially among uncorrected accessibility errors. This allows the author to quickly scan accessibility problems in context.
Technique B.2.3-1.7 [Advisory]: Consulting the Techniques For Accessibility Evaluation and Repair Tools [WAI-ER @@change to AERT@@] Public Working Draft document for evaluation and repair algorithms.
This list is representative, but not complete.
(a) Repair Instructions: In manual repairing, the tool provides the author with instructions for making the necessary correction, but does not automate the task in any substantial way. For example, the tool may move the cursor to start of the problem, but since this is not a substantial automation, the repair would still be considered "manual". Manual correction tools leave it up to the author to follow the instructions and make the repair by themselves. This is the most time consuming option for authors and allows the most opportunity for human error.
Example of repair instructions (1): This illustration shows how repair instructions might work in a code level editing view where the following markup is being edited:
<body><p>Image:</p><img href="pic123.gif"/><hr/><blink>Blinking text</blink></body></html>
. In this case, while the problems have already been detected in the checking step and the selected offending elements in a code view (<img href="pic123.gif"/>
and<blink>Blinking text</blink>
) have been highlighted in blue text. When the author puts focus on the highlighted text, a short repair instruction ("Repair: Add 'alt' attribute") appears in a status bar with a button than will open a longer explanation in the help system. (Source: mockup by AUWG)
(b) Semi-Automated: In semi-automated repairing, the tool can provide some automated assistance to the author in performing corrections, but the author's input is still required before the repair can be complete. For example, the tool may prompt the author for a plain text string, but then be capable of handling all the markup required to add the text string to the content. In other cases, the tool may be able to narrow the choice of repair options, but still rely on the author to make the final selection. This type of repair is usually appropriate for corrections of a semantic nature.
Example of semi-automated repair (1): This illustration shows a sample of a semi-automated repair in a WYSIWYG editing view. The author has right-clicked on an image of the "earthrise" that has been highlighted with a blue outline by the automated checker system. This has brought up a pop up menu with the following choices: "Repair: Set Alt -Text: 'An earth rise as seen from the moon'", "Enter different alt-text…", " Skip", "Ignore", "Check Accessibility...", "Help...". The author must decide whether the label text that the tool suggests is appropriate. Whichever option the author chooses, the tool will handle the details of updating the content. (Source: mockup by AUWG)
(c) Automated: In automated repairing, the tool is able to make repairs automatically, with no author input required. For example, a tool may be capable of automatically adding a document type to the header of a file that lacks this information. In these cases, very little, if any, author notification is required. This type of repair is usually appropriate for corrections of a syntactic or repetitive nature.
Example of automated repairing (1): This illustration shows a sample of an announcement that an automated repair has been completed ("All instances of <blink> have been replaced with CSS styling according to your preferences."). The author selects an "ok" to proceed. An "undo " button is provided in case the author wishes to reverse the operation. In some cases, automated repairs might be completed with no author notification at all. (Source: mockup by AUWG)
Applicability: This success criteria is applicable to authoring tools that support non-text objects.
Technique B.2.4-1.1 [Sufficient for (a)]: Placing, within the appropriate field of the non-text object editing dialog box, a text alternative (or multiple alternatives if a drop-down is used) that was previously entered by themselves or by other authors with whom they collaborate (e.g. in a workgroup).
Technique B.2.4-1.2 [Sufficient for (b)]: Placing, within the appropriate field of the non-text object editing dialog box, a text alternative (or multiple alternatives if a drop-down is used) that is stored with the non-text object in an image database such as a clip art collection.
Technique B.2.4-1.3 [Sufficient for (c)]: Placing, within the appropriate field of the non-text object editing dialog box, a null text alternative if the tool is making use of the image only for visual formatting.
Technique B.2.4-1.4 [Sufficient]: Not offering the author text alternatives for non-text objects at all. Leaving out the relevant markup for the alternative equivalent (e.g., attribute, element, etc.), rather than including the attribute with no value or with automatically-generated content if the author has not specified an alternative equivalent. Leaving out the markup will increase the probability that the problem will be detected by checking algorithms.
Applicability: This success criteria is applicable to authoring tools that support non-text objects.
Technique B.2.4-2.1 [Sufficient]: If human-authored equivalent alternatives are available for an object that is being inserted (through a management functionality (see Checkpoint B.2.5) or equivalent alternatives bundled with pre-authored content (see Checkpoint B.1.5)), then offering the alternatives to the author as default text, requiring confirmation. Inserting the alternatives without author confirmation is not required when the function of the object is known with certainty as in the following situations: (a) the tool totally controls its use (e.g., a button graphic on a generated tool bar); (b) the author has linked the current object instance to the same URI(s) as the object was linked to when the equivalent alternative was stored; or (c) there is semantic role information stored for the object that matches that for the stored alternative.
Technique B.2.4-2.2 [Advisory]: If a non-text object has already been used in the same document, offering the alternative information that was supplied for the first or most recent use as a default.
Technique B.2.4-2.3 [Advisory]: If the author changes the alternative equivalent for a non-text object, asking the author whether all instances of the object with the same known function should also be updated.
Applicability: This success criteria is applicable to authoring tools that support non-text objects.
Technique B.2.5-1.1 [Sufficient] : Maintaining a registry that associates object identity information with the text and URI's of alternative information (e.g., making use of the Resource Description Framework (RDF) [RDF10]). Whenever an object is used and an equivalent alternative is collected, via prompting (see Checkpoint B.2.1) or repair (see Checkpoint B.2.3) the object's identifying information and the alternative information is added to the registry. The stored alternative information is presented back to the author as default text in the appropriate field, whenever the associated object is inserted (see also Checkpoint B.2.4).
Technique B.2.5-1.2 [Advisory]: Providing a entry editing capability. (see Example B.2.5-1.2)
Example B.2.5-1.2: This illustration shows a text equivalents registry viewer that a tool can include to allow the author to query and edit the various text equivalents stored in the registry. For maximum flexibility, the design takes into account multiple non-text objects of the same name, multiple types of text equivalents for each non-text object, and multiple versions of each text equivalent type. In the viewer shown here, the author has selected "image" as the "media type" and then selected pic123.gif as the "object" to edit. This has brought up a rendering of the "earthrise" image. The viewer also shows that the object has three text labels. The author has selected one ("An earth rise as seen from the moon") in order to edit it. In addition some authoring tips are included ("Alternate text should be 10 words or less and should include any text in the image", "Image buttons should have alternate text that describes the button function.", and "Image bullets should have "bullet" as alternate text."(Source: mockup by AUWG)
Technique B.2.5-1.3 [Advisory]: Allowing several different versions of alternative information to be associated with a single object.
Technique B.2.5-1.4 [Advisory]: Ensuring that the stored alternative information required for pre-authored content (see Checkpoint B.1.5) is made interoperable with the management system to allow the alternative equivalents to be retrieved whenever the pre-authored content is inserted.
Technique B.2.5-1.5 [Advisory]: Using the stored alternatives to support keyword searches of the object database (to simplify the task of finding relevant images, sound files, etc.).
Technique B.2.5-1.6 [Advisory]: Allowing the equivalents alternatives registry to be made shareable between authors in collaborative systems.
Applicability: This success criteria is applicable to authoring tools that are capable of introducing accessibility problems (i.e., not tools that constrain author actions to the point where accessibility problems are not possible).
Technique B.2.6-1.1 [Sufficient]: Providing, at all times, the option to view a single consolidated list of all of the accessibility problems that are detected by the checking function (see Checkpoint B.2.2), organized by problem type and number of instances.
Technique B.2.6-1.2 [Advisory]: Storing accessibility status information in an interoperable form (e.g., using Evaluation and Repair Language [EARL]).
Technique B.2.6-1.3 [Advisory]: Providing direct links to additional help and repair assistance from the list of accessibility problems.
Applicability: This success criteria is applicable to all authoring tools.
Technique B.2.7-1.1 [Sufficient]: Providing a tutorial that contains a method for using the authoring tool to increase the accessibility of Web content. The tutorial begins at the typical starting point for the tool (e.g., empty document) and describes how accessibility prompting and assistance can be used as content is being added or modified. The tutorial also covers when and how checking and repair should be performed.
Technique B.2.7-1.2 [Advisory]: Ensuring that wherever rationales appear, they avoid referring to accessibility features as being exclusively for particular groups (e.g., "for blind authors"). Instead, they emphasize the importance of accessibility for a wide range of content consumers, from those with disabilities to those with alternative viewers (see "Auxiliary Benefits of Accessibility Features", a W3C-WAI resource).
Technique B.2.7-1.3 [Advisory]: Providing a dedicated accessibility section.
Technique B.2.7-1.4 [Advisory]: Providing context-sensitive help definitions for accessibility-related terms.
Technique B.2.7-1.5 [Advisory]: Including pointers to more information on accessible Web authoring, such as WCAG and other accessibility-related resources.
Technique B.2.7-1.6 [Advisory]: Including pointers to relevant content type specifications. This is particularly relevant for languages that are easily hand-edited, such as most XML languages.
Technique B.2.7-1.7 [Advisory]: Calling author attention to accessibility-related idiosyncrasies of the tool compared to other authoring tools that create the same kind of content (e.g., that content must be saved before an automatic accessibility check becomes active).
This guideline requires that authoring tools must promote accessible authoring practices within the tool as well as smoothly integrate any functions added to meet the other requirements in this document.
Note: In addition to the normative requirements of this guideline, implementers should consider one other issue: the integration of features that support accessible authoring with the "look-and-feel" of other features of the authoring tool. This type of integration has the potential to:
However, whenever new features are introduced into an authoring tool, striking the right design balance between the similarity with existing features and the provision of new functionality is often more of an art than a science.
Applicability: This success criteria is not applicable to authoring tools that have only one method for performing each task.
Technique B.3.1-1.1 [Sufficient]: Ensuring that, if there are two or more authoring options for performing the same authoring task (e.g., setting color, inserting multimedia, etc.) and one option results in content that agrees with the relevant content type-specific WCAG benchmark while the other does not, the more accessible option is given authoring interface prominence.
Example B.3.1-1.1: This illustration shows an authoring tool that supports two methods for setting text color: using CSS and using
font
. Since using CSS is the more accessible option, it is given a higher prominence within the authoring interface by: (1) the "CSS Styling" option appearing above the "FONT Styling" option in the drop down Text menu, and (2) the CSS styling option being used to implement the one-click text color formatting button in the tool bar. The association is made clear because the toolbar button has the same icon (an "A" beside a color spectrum) as the "Color" sub-menu item under the "CSS Styling" menu option.). An (Source: mockup by AUWG)
Technique B.3.1-1.2 [Sufficient]: Completely removing less accessible options simplifies the task of meeting this success criteria.
Applicability: This success criteria is not applicable to authoring tools that do not provide choices that will lead directly to accessibility problems.
Technique B.3.1-2.1 [Sufficient]: Ensuring that, when an option will lead directly to content being created using a content type for which there is not a content type-specific WCAG benchmark or content that does not agree with the relevant content type-specific WCAG benchmark, the author is warned (e.g., be a warning message, by an informational icon, etc.).
Technique B.3.1-2.2 [Sufficient]: Completely removing choices that will lead directly to content being created using a content type for which there is not a content type-specific WCAG benchmark or content that does not agree with the relevant content type-specific WCAG benchmark simplifies the task of meeting this success criteria.
Applicability: This success criteria is not applicable to authoring tools that do not provide interactive features that help sequence author actions (e.g., many basic text editors).
Technique B.3.2-1.1 [Sufficient]: Ensuring that any feature that sequences authoring actions (by allowing different defined sets of actions at different points in a process) integrates accessibility prompting in such a way that there is no opportunity to finalize an authoring decision before prompting related to the accessibility implications of that decision.
Example B.3.2-1.1: This illustration shows three consecutive screens of a page building wizard (an example of indirect authoring). The wizard prompts the author for a few key pieces of information that are used to tailor the process, in this case to create a gallery page. In the first step, the author is prompted for a title ("Space Pictures"), a page type ("Gallery") and a style ("SciFi"). The only available navigation button is "Next >". In the second step, the author is prompted to add the first image. The available navigation button s are now "< Previous" and "Next >". In the third step, the author is prompted for accessibility information ("label" and "description" for the image ("earthrise") which is displayed as a rendered preview). This is the first step in which the "Finish" navigation button becomes available. (Source: mockup by AUWG)
Technique B.3.2-1.2 [Advisory]: Integrate checking and repairing into sequencing mechanisms (e.g., design aids, wizards, templates).
Example B.3.2-1.2: This illustration shows the wizard screen that immediately follows the sequence in Example B.3.2-1.1. Since no text was entered in the description field, a warning message is displayed ("Missing Description for 'Gallery Image 1'" along with a space to add a description and a preview rendering of the image ("earthrise" ). (Source: mockup by AUWG)
Technique B.3.2-1.3 [Advisory]: Choosing timing options that prompt early in the workflow (see Timing Options). This averts the need for more disruptive checking and repair later in the workflow.
Technique B.3.2-1.4 [Advisory]: Detecting and immediately highlighting accessibility problems when documents are opened, when an editing or insertion action is completed, or while an author is editing.
Technique B.3.2-1.5 [Advisory]: If intrusive warnings are used, providing the option to select a less obtrusive method of alerting.
Technique B.3.2-1.6 [Advisory]: Providing the author with immediate access to some basic accessibility documentation and one-step access to more comprehensive documentation.
Example B.3.2-1.6: This illustration shows an accessibility checker with some limited short label authoring tips listed beneath the text entry area as well as a "Help" button linking to the full documentation. The tips are: "Alternate text should be 10 words or less and should include any text in the image.", "Image buttons should have alternate text that describes the button function.", and "Image bullets should have 'bullet' as alternate text.". The screenshot also includes the name of the problem ("Missing Alternate Text Label for an Image"), a field for adding the short text label and a preview rendering of the image ("earthrise"). At the bottom are five buttons: "Help", "< Back", "Repair", "Skip", and "Cancel". (Source: mockup by AUWG)
Technique B.3.2-1.7 [Advisory]: Providing a tight coupling between all of the accessibility-related functions, leading to a more seamless authoring experience.
Example B.3.2-1.7: This illustration shows a sequence of steps through a WYSIWYG user interface in which prompting, checking, repair, and documentation of accessibility issues are all integrated into the process of creating a table. In the first step , the author has requested that a table be inserted. The tool prompts the author for accessibility information (i.e., caption and summary) at the same time as it prompts for the number of rows, number of columns, border and width. In the second step, as the author finishes filling in the top row of cells, the tool has checked the structure of the table and found that no header cells have been defined. To prompt the author to address this problem, the tool highlights the top row of the table in a blue outline. When the author selects the highlighted area a drop-down is displayed that lets the user choose whether to let the tool make the repair ("Repair: Set as header row"), skip the problem for now ("Skip") or ignore the problem from here on ("ignore"). The last options are "Check Accessibility" to open a full checker and "Help". In the third step , the author has added a new row to the top of the table and merged two cells in this new top row. The tool again checks the table, highlights the problem and facilitates the repair ("Repair: Set as header cell for sub-headers"). (Source: mockup by AUWG)
Technique B.3.2-1.4 [Advisory]: Dealing flexibly with real-time content production. When authoring tools produce content in real time, it is usually no longer possible to delay addressing accessibility problems until an arbitrary point in the future. At the same time, due to the time pressure, authors in real-time environments tend to be less receptive to intrusive prompts. Nevertheless, tools that allow this kind of authoring should still take accessibility issues into account by supporting the following:
(a) Determination of Participant Requirements: If real-time authoring is consumed by individuals with no special communicative needs, there may be no need for real-time prompting. However, as with any other Web content it is often impossible for the author to know all of the needs of the actual or potential participants. Therefore, the best practice is to create real-time content that conforms with WCAG to the greatest extent possible. However, when this is not possible, a real-time authoring tool might be able to facilitate graceful degradation of accessibility by polling the participants (see "Request whiteboard descriptions" checkbox in the figure) or in some cases checking the profiles of participants (e.g., using CCPP, ACCLIP) to determine which types of accessibility practices would offer the greatest advantage in the short time available. Once this information is compiled, the tool can prompt the author (or see Assistant/Peer Author) to correct problems appropriately (preferably during Preparation Time). When it is not possible to know, with certainty, the needs of all participants, the tool should still assume that accessible content is required. This is especially true if the results of the session will be archived.
(b) Assistant/Peer Author: In some cases, it may be possible to designate one or more secondary authors in the live community, who can receive and respond to prompts for supplemental information generated as the primary author proceeds uninterrupted. The secondary author might be an unrelated specialist, analogous to Sign language interpreter, a co-author (helpful for describing technical drawings, etc.), or in some situations any member of the session audience (i.e., a peer).
(c) Preparation Time: If the authoring tool allows the author time to pre-assemble materials for a live presentation (e.g., a professor preparing for an online class), this authoring is not considered real-time authoring. The authoring tool has the opportunity and the obligation to support accessible authoring as described elsewhere in this document.
(d) Archiving: If the session will be archived, there may be other opportunities to increase the accessibility of the content of the archive by guiding the author through a process to check for and repair accessibility problems after the real-time session has ended, but prior to archiving.
If it has been determined that the author must provide real-time supplements, but no preparation time or assistant author are available, then in addition to allowing the author control of the nature and timing of prompting, the authoring tool can facilitate the inclusion of supplements by:
- Implementing the management functionality for equivalent alternatives (see Checkpoint B.2.5). This way, if the author uses an object that has been used before, the tool can suggest the previously stored alternative, which the author can quickly accept or decline without substantial workflow disruption.
- Providing a voice recognition capability so that the author's real-time speech input can be converted into captioning.
Example B.3.2-1.4: This illustration shows an a real-time presentation in a whiteboard/chat client environment that has been enhanced to provide real-time descriptions. The example has five panes. On the far left is a list of participants ("Presenter", "John (You)", "Jane", and "Alice"). In the upper-middle is the chat "Presenter> I suggest a space theme for the slide presentation.", "Image File Inserted (by Presenter) Description: An earthrise as seen from the surface of the moon.", "Presenter> The white text would go...", "Marker (by Presenter) Description> Draws a red box..., and "Presenter> in this area." Notice that descriptions are appearing here. The lower-middle is the message composition area for this user and is blank. The upper-right is the whiteboard. So far there is an image of "earthrise" and a red hand-drawn rectangle on the "canvas". The whiteboard tools are "select box", "text tool", "marker", "eraser", "insert image", "line tool", "rectangle tool", and an "ellipse tool". In the lower-right is an area for describing a drawing action - in this case the "Presenter' use of the Marker". Notice that any participant can describe the events on the whiteboard even as the dialog continues. (Source: mockup by AUWG).
Applicability: This success criteria is not applicable to authoring tools that do not provide read-only instruction text that includes a sequence of steps for the author to follow.
Technique B.3.2-2.1 [Sufficient]: Ensuring that in any set of instruction steps, the first point at which the author could successfully complete the action (and introduce an accessibility problem) is after the point at which the relevant accessibility authoring practice has been introduced.
This list is representative, but not complete.
(a) Negotiated Interruption: A negotiated interruption is caused by interface mechanisms (e.g., icons or highlighting of the element, audio feedback) that alert the author to a problem, but remain flexible enough to allow the author to decide whether to take immediate action or address the issue at a later time. Since negotiated interruptions are less intrusive than immediate or scheduled interruptions, they can often be better integrated into the design workflow and have the added benefit of informing the author about the distribution of problems within the document. Although some authors may choose to ignore the alerts completely, it is not recommended that authors be forced to fix problems as they occur. Instead, it is recommended that negotiated interruption be supplemented by scheduled interruptions at major editing events (e.g., when publishing), when the tool should alert the author to the outstanding accessibility problems.
Example of negotiated interruption: This illustration shows an example of a negotiated interruption in a WYSIWYG editing view. The author is made aware of problems detected automatically by means of a blue line under text or around rendered objects with accessibility problems. Here red lines are also visible, highlighting spelling errors in the text. The author can decide to address the problems at a later time. (Source: mockup by AUWG)
(b) Scheduled Interruption: A scheduled interruption is one in which the author has set the tool to alert them of accessibility issues on a configurable schedule. One option for the schedule might be to have prompts associated with the interface mechanisms for significant authoring events, such as opening, saving, closing, committing, or publishing files. At the significant authoring event, the author would be informed of the problem, while at the same time they would not be prevented from saving, publishing, printing, etc. A potential downside of postponing corrective actions is that by the time the prompt is displayed, the author may not have sufficient time or inclination to make the required changes, especially if they are extensive.
Example of scheduled interruption: This illustration shows a "Publish" dialog box that is an example of a scheduled interruption. The dialog allows the author to publish multiple files at once, however in the case shown here, two of the files have uncorrected accessibility errors which causes them not to meet a "standard of publishing" the author has set for themselves in the options. As a result the files are selected. a message is displayed (" The selected files do not meet your specified standard for publishing.") and the "publishing" button is grayed out. This standard is referred to generally since it is assumed that it might include spelling and grammar standards as well as accessibility issues. (Source: mockup by AUWG)
(c) Immediate Interruption: An immediate interruption is the most intrusive timing option because the attention of the author is actively diverted from the current editing task by the notification of some issue. This might be achieved, for instance, by an alert dialog. This type of alert presents multiple usability problems and should be used sparingly because it interferes with the normal design workflow. Intrusive warnings are probably only appropriate when the window of opportunity for correcting a serious accessibility problem is about to close, such as when an author decides to publish the content in question. In general, negotiated and scheduled interruptions are preferred.
Example of immediate interruption: This illustration shows an example of an immediate interruption of the author's workflow. The dialog box contains the message: "This image is missing alternate text". The author must press the "OK" button to continue. (Source: mockup by AUWG)
Rationale: If the features that support accessible authoring are difficult to find and activate, they are less likely to be used. Ideally, these features should be turned on by default.
Applicability: This success criteria is applicable to authoring tools that provide accessibility prompting, checking, repair functions, or documentation.
Sufficiency: Technique B.3.3-1.1, Technique B.3.3-1.2, and Technique B.3.3-1.3, in combination, are sufficient to meet this checkpoint.
Technique B.3.3-1.1 [Sufficient in combination] : Ensuring that prompting for accessibility information has the same prominence as prompting for information critical to content correctness (e.g., a tool that prompts the author for a required multimedia file name attribute has prompts with the same prominence for short text labels and long descriptions for that object (see Example B.3.3-1.1).
Example B.3.3-1.1: This illustration shows an "Image Properties" dialog box in which the input fields are ordered (from top to bottom, left to right): source ("src"), short label ("alt"), long description ("longdesc"), height, and width. The buttons at the bottom are "More...", "OK" and "Cancel". (Source: mockup by AUWG )
Technique B.3.3-1.2 [Sufficient in combination]: Ensuring that utilities for checking and repairing accessibility problems has the same prominence as utilities for checking for information critical to content correctness (e.g., a tool that checks for spelling, grammar, or code syntax will have checks with the same prominence as checking for accessibility problems (see Example B.3.3-1.2)).
Example B.3.3-1.2: This illustration shows an authoring interface that checks for and displays spelling and accessibility errors with the same prominence in that both are shown as underlines, one red, one blue. In this case, the author has activated a right-click pop-up menu on the word "CHZ" that includes spelling repair options ("1 Khz", "2 Chi", "Check Spelling...") and accessibility repair options ("Repair: Set acronym expansion…", "Skip", "Ignore", and "Check Accessibility...") and "Help...". (Source: mockup by AUWG)
Technique B.3.3-1.3 [Sufficient in combination]: Ensuring that documentation for accessibility has the same prominence as documentation for information critical to content correctness. (e.g., a tool that documents any aspect of its operation will have documentation with the same prominence for accessibility).
Example B.3.3-1.3: This illustration shows how the accessibility documentation has been added directly to the main documentation, with very similar prominence to that of the spelling-related features. In the right pane is the documentation table of contents, where "Accessibility Features" appears as a top level topic just below "Spelling Features". In the left panel is the help text, demonstrating a style typical of the rest of the help system: "Checking for Accessibility: A variety of accessibility checking options are available: Accessibility verifier, Check accessibility as you type, Manual test support materials. These are suitable for use at different times during the authoring process and all have options that can be changed with the accessibility preferences. To get more information on accessible Web content, see the References.". (Source: mockup by AUWG)
Applicability: Techniques in this section are not necessarily applicable to any one success criteria, and may apply more generally to the checkpoint as a whole.
Technique B.3.3-G.1 [Advisory]: Grouping input controls when several pieces of information are all required from the author as part of an accessible authoring practice.
Applicability: This success criteria is only applicable to authoring tools that provide accessible content support features (e.g., accessibility prompting, checking, repair).
Technique B.3.4-1.1 [Sufficient]: Ensuring that all accessible content support features are turned on by default within the authoring tool preferences area.
Example B.3.4-1.1: This illustration shows the preference setting area of a given authoring tool, open to an "Accessibility" section. The mockup begins with an area for setting the "Target Accessibility Standards". The author has the option selecting "W3C-WCAG" and a level (e.g. "Double-A"), "U.S. Section 508", or a custom setting via the "Customize..." button. (All of the following options are considered "continuously active" for the purpose of the technique). The author has the following "Accessibility Checking" options: "Check accessibility as you type", "Check accessibility after saving", and "Auto-correct when possible". They also have the following "Accessibility Highlighting" options: "Highlight accessibility related fields" and "Prompt when highlighted fields are left blank". And finally the author has an "Accessibility Help" option: "Provide accessibility 'Quick Tips'". (Source: mockup by AUWG)
Applicability: This success criteria is only applicable to authoring tools that provide a way to turn off accessible content support features (e.g., accessibility prompting, checking, repair).
Technique B.3.4-2.1 [Sufficient]: Providing the author with a warning whenever an accessible content support feature is turned off (e.g., from the authoring tool preferences area .
Example B.3.4-2.1: In a given authoring tool, the author has unchecked a "highlighting accessibility related fields" feature the tool. As a result the tool displays a warning that reads "You have just turned off the highlighting accessibility related fields feature. This feature is designed to inform you when information must be provided in order for your documents to comply with your target accessibility setting. Turning this feature off could cause your documents to be less accessible to many users. In some jurisdictions accessibility is a legal requirement. Are you sure you want to proceed?". The author has the option to answer "Yes", "No" or "Cancel". (Source: mockup by AUWG)
Applicability: This success criteria is only applicable to authoring tools that provide a way of turning off accessible content support features (e.g., accessibility prompting, checking, repair).
Technique B.3.4-3.1 [Sufficient]: Providing an authoring tool preferences area where the deactivated features can be reactivated.
Applicability: This success criteria is only applicable to authoring tools that provide a preference settings for accessible content support features (e.g., accessibility prompting, checking, repair).
Technique B.3.4-4.1 [Sufficient]: Saving all author settings between sessions
Applicability: Techniques in this section are not necessarily applicable to any one success criteria, and may apply more generally to the checkpoint as a whole.
Technique B.3.4-G.1 [Advisory]: Enhancing configurability of accessibility features beyond what exists for other related features. Some potential configuration options:
- the nature of the accessibility guidance they wish to receive,
- the degree to which the prompts are highlighted in the interface,
- the nature and timing of any automated accessibility features (e.g., accessibility checking or repairing utilities), and
- which accessibility standards they wish to follow, and where applicable, to which level
Applicability: This success criteria is only applicable to authoring tools that provide accessible content support features (e.g., accessibility prompting, checking, repair).
Technique B.3.5-1.1 [Sufficient]: Ensuring that the help system answers the question "What features of the tool encourage the production of accessible content?" with reference to all of the accessible content support features. Also ensuring that, for each feature identified, the help system answers the question "How are these features operated?".
Technique B.3.5-1.2 [Advisory]: Providing direct links from accessible content support features to context sensitive help on how to operate the features.
Technique B.3.5-1.3 [Advisory]: Providing direct links from within the accessibility related documentation that take the author directly to the relevant accessible content support features.
Applicability: This success criteria is applicable to authoring tools that include documentation on how to author content and/or repair instructions that are meant to be used by authors to fix existing content problems (e.g., accessibility problems, validity problems, etc.).
Technique B.3.6-1.1 [Sufficient]: Ensuring that all examples of content pass the tool's own accessibility checking mechanism (see Checkpoint B.2.1). Also ensuring that all screenshots of the authoring interface show the authoring interface in a state that corresponds to full and proper use of the accessibility features of tool (e.g., prompts filled in, optional accessibility features turned on, etc.).
Example B.3.6-1.1: This illustration shows documentation for the
input
element in this code-level authoring tool makes use of thelabel
element in an example in order to reinforce the routine nature of the pairing. The help text reads: "Input Element: Input elements are form controls. They let the reader of your page use text entry, checkboxes, radio buttons, etc. to interact with your page. The most important attribute of the INPUT element is type. The value of type can be: button, checkbox, file, hidden, image, password, radio, reset, submit, and text. Examples:<label>Enter your name: <input type="text" name="name" maxlength="30"></label><input type="submit">
.(Source: mockup by AUWG)
Technique B.2.8-1.2 [Advisory]: Providing, In the documentation, at least one model of each accessibility practice in the relevant WCAG techniques document for each language supported by the tool. Include all levels of accessibility practices.
Technique B.2.8-1.3 [Advisory]: Ensuring that plug-ins that update the accessibility features of a tool also update the documentation examples.
Contents | Part A | Part B | References