Document accessibility features

Checkpoint 1: Accessible format

This page provides specific examples to implement the documentation techniques for accessible documents in Lotus Symphony Documents.


Rationale

To ensure that all users can access documentation, you must provide documents in an accessible format. If documentation is provided in multiple formats, at least one of the formats must be accessible and the accessible version must be clearly identified.


Required development techniques

The following techniques are the minimum required to meet Checkpoint 1 from the IBM Documentation Accessibility Checklist for documents created with Lotus Symphony Documents:

1.1 Non-text Content: All non-text content that is presented to the user has a text alternative that serves the equivalent purpose.

1.1.1 Alternative text: Provide alternative text for all images.

Example 1

Select the image and open the Graphic Properties via Layout-Properties-Graphic Properties. Select the Alternative Text tab and in the Alternative Text field, enter a text description of the image.

Required test for development technique 1.1.1

Check manually that the alternative text for each image adequately describes it.

1.1.2 Text description: Provide a text description in addition to alternative text for complex charts and graphs.

Example 2

For images or charts provide alternative text for the image. If the image cannot be adequately described using alternate text, provide a more detailed description in the surrounding text

Required test for development technique 1.1.2

If alternative text is used, manually review the text for each image to verify it adequately describes the image. If alternative text cannot be used, manually review the surrounding text to verify the image is adequately described.

1.2 Information and Relationships: Define information, structure, and relationships.

1.2.1 Structure: Define document structure.

Example 3

Properly format all text used as section headings by using styles such as "Heading 1", "Heading 2", etc. This allows screen readers to create an outline of the document. Using bold text to indicate headings is not sufficient to create an accessible document.

Required test for development technique 1.2.1

Manually review the markup using the editor. You can also use Symphony’s built-in Navigator (Ctrl+Shift+F5) to verify headings are properly marked in the document.

1.2.2 Text formatting: Do not use text formatting as the only way to convey meaning.

There are no unique examples for this technique in Symphony Documents. Please follow the general examples for text formatting to meet this checkpoint.

Required test for development technique 1.2.2

Manually review the markup using the editor.

1.2.3 Link purpose: Identify the purpose of each link in the link text.

There are no unique examples for this technique in Symphony Documents. Please follow the general examples for accessible link texts to meet this checkpoint.

Required test for development technique 1.2.3

Manually review each link using the editor. You can also use Symphony’s built-in Navigator (Ctrl+Shift+F5) to verify the links in the document.

1.3 Color & contrast: Any information that is conveyed by color is also evident without color.

1.3.1 Color alternatives: Do not use color as the only way to convey meaning.

There are no unique examples for this technique in Symphony Documents. Please follow the general examples for color to meet this checkpoint.

Required test for development technique 1.3.1

Manually review the document to verify proper use of color.

1.3.2 Sufficient color: Provide sufficient contrast between text and the page background.

There are no unique examples for this technique in Symphony Documents. Please follow the general examples for text contrast to meet this checkpoint.

Required test for development technique 1.3.2

Manually review the document to verify sufficient contrast between text and page background.

1.4 Meaningful sequence: Define document reading order.

1.4.1 Reading order: Define document reading order.

Example 4

Ensure that document elements are presented in a logical reading order. Avoid complex layout, sidebars and other ornamentation as they make it difficult to maintain a logical reading order.

Required test for development technique 1.4.1

If your document contains complex layout, use a screen reader to verify the reading order.

1.5 Forms: Define form element labels.

1.5.1 Form labels: Provide an accessible label for form fields.

There are no unique examples to implement links in Symphony Documents. Please follow the general examples for implementing labels to meet this checkpoint.

Required test for development technique 1.5.1

Manually review to verify accessible labels are provided for all form fields.

1.6 Tables: Identify table cells and relationships between cells.

1.6.1 Table headers: Identify row and column headers for data tables.

Example 5

To create accessible data tables:

Required test for development technique 1.6.1

Manually review the table to verify the row and column headers are properly identified and the caption adequately describes the purpose of the table.

1.7 Threshold violations: Do not include text or images that flash more than 2 times in a one second period.

1.7.1 Flashing content: Do not include text or images that flash more than 2 times in a one second period.

There are no unique examples for this technique in Word. Please follow the general examples images that flash to meet this checkpoint.

Required test for development technique 1.7.1

Manually review to verify images do not flash more than 2 times in one second period.

1.8 Navigation: Provide an accessible method to navigate long documents.

1.8.1 Navigation: Provide an accessible method to navigate long documents.

Example 6

Properly format all text used as section headings by using styles such as "Heading 1", "Heading 2", etc. This allows screen readers to create an outline of the document and make the outline available to the user for navigation. Using bold text to indicate headings is not sufficient to create an accessible document.

Example 7

Provide a Table of Contents for long documentation. Table of Contents enables the screen reader user the ability to easily navigate to specific sections of the document.

Required test for development technique 1.8.1

Manually review the markup using the editor. You can also use Symphony’s built-in Navigator (Ctrl+Shift+F5) to verify headings are properly marked in the document.

1.9 Language of Page: Define the default language.

1.9.1 Language definition:Define the language of the document.

Choose File - Preferences - IBM Lotus Symphony - Language Settings - Languages to verify the primary language of the document is accurate so screen readers can correctly read the content.

Required test for development technique 1.9.1

Manually review the language is set.


Recommended development techniques

The techniques above are required; the following techniques are recommended to enhance accessibility:


 

©2012 IBM Corporation

Last updated November 1, 2010