NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This page gathers documents that the Documentation Team has found or developed regarding Section 508 compliance. These documents will be posted in the appropriate place after consultation with other members of the Training and Development Team.

Creating Accessible Technical Documents at CBIIT

To make our documents compliant with Section 508 of the Rehabilitation Act, we must prepare our source files and then test our output files. The tools we currently use to create our source files, Adobe FrameMaker and Microsoft Word, both allow us to prepare for accessibility.

...

Anchor
preparingframe
preparingframe
Preparing FrameMaker Files For Accessibility

The following table summarizes how to prepare a FrameMaker document for accessibility.

...

Anchor
addingalttext
addingalttext
Adding Alternate Text to Images

Alternate (alt) text is typically used for describing an image so that screen readers can read it aloud.

...

Step

To add an alternate text description to an image in FrameMaker

1

Place the graphic in an anchored frame.

2

Click an anchored frame one time to select it.

3

Right-click the anchored frame and select Object Properties.

4

Click the Object Attributes button. The Object Attributes dialog box appears.

5

In the Alternate box, type an alternate text description for the content of the anchored frame.

6

Actual text is for reading aloud the actual text, as in the case of a drop cap. For example, if the author is using a drop cap for the letter A in the word "Adobe" but still wants the screen readers to read the word as "Adobe" and not as "dobe," this can be done by filling in actual text.

7

Click Set and then Set again. A screen reader can now read the alternate text.

Anchor
usingtablemanners
usingtablemanners
Using Good Table Manners

Section 508 differentiates between data tables and tables used purely for layout purposes, which it calls layout tables. A layout table would not have a table header. Most of our tables at CBIIT are data tables.

...

We do not currently produce output for table or figure captions in the help we create with ePublisher. We can either change that practice or make sure to summarize a table when we introduce it, even in help output.

Anchor
naminglinkanchors
naminglinkanchors
Naming Link Anchors

Most tips regarding the accessibility of links concern proper coding of them so that all users can tab between them using a keyboard. Links also need to have a unique appearance so that they can always be identified as links. Our tools take care of both of these things.

...

  • It is also a good general practice to introduce any link by describing the advantage that will be gained by following it.

Anchor
taggedpdffromfm
taggedpdffromfm
Creating a Tagged PDF from FrameMaker

Tagged PDF files contain a document's logical structure and metadata, and are the most reliable format for the following:

...

Step

To set up a tagged PDF in FrameMaker

1

Click File > Print or File > Print Book. Select Adobe PDF as your printer.

2

Select the Generate Acrobat Data option and then click the PDF Setup button. The PDF Setup dialog box appears.

3

Click the Tags tab. Select the Generate Tagged PDF option and then do the following:

  1. Move paragraph tag names to the Include Paragraphs list to indicate paragraphs you want included in the PDF logical structure.
  2. Select a paragraph tag name and then use the arrows located directly under that list to indicate the structure level of the selected paragraph.

4

Click Set.

Anchor
preparingword
preparingword
Preparing Word Files For Accessibility

Microsoft Word also contains the tools necessary to create accessible documents. Perhaps the most important contributing factor to an accessible Word document is the use of Word styles. Properly structured documents that do not use override styles but rather styles defined by a template are the easiest for a screen reader to follow.

...

For detailed information about creating accessible Word files, see
http://www.webaim.org/techniques/word/. You can also find detailed information in the online help for Adobe Acrobat.

Anchor
accessiblepdfs
accessiblepdfs
Creating Accessible PDFs

Although the HHS says that PDFs do not need to be 508 compliant if a compliant HTML version of the document exists, it is a good idea to get in the practice of taking as many steps as you can to improve your PDF document's accessibility.

...

Step

To create accessible PDFs

1

In the document properties, enter NCI CBIIT as the Author. In the Keywords field, enter 508 Compliant as one of your keywords.

2

Anchor
doclanguage
doclanguage
Specify document language.

  1. Select File > Document Properties.
  2. Click the Advanced tab.
  3. In the Language list, select English.

3

Anchor
docstructure
docstructure
Use the document structure to prevent errors in the accessibility report.

  1. Select all pages in the document.
  2. Right-click and then select Page Properties.
  3. Select Use Document Structure.

4

Run an accessibility full check using the Adobe PDF option.

  1. Select Advanced > Accessibility > Full Check. The Accessibility Full Check dialog box appears.
  2. Keep the defaults, which includes the checking option of Adobe PDF.
  3. Click Start Checking.

5

Fix any problems reported by the accessibility checker. Documents from Word tend to have more problems than documents from FrameMaker. For example, alternate text you add to images in Word do not always carry over to Acrobat. In this case, you would need to add the alternate text again in Acrobat. Use the accessibility checker report as a troubleshooting guide to narrow down problem areas. Our goal is for Acrobat to tell us that we have no accessibility errors. Beyond that it is useful to test the document using a screen reader. See this table for suggestions for simulating the experience of a person using assistive technology.

To begin post-processing in Acrobat, select Accessibility > TouchUp Reading Order. In the TouchUp Reading Order dialog box, click Show order panel, then do the following.

  • Confirm that each numbered box in the document is properly tagged.
  • Add alternate text as needed to figures as needed.
  • Remove nonessential content, such as ornamental page borders, from the logical structure tree as needed (files from Word tend to create a lot of nonessential tags that can be deleted in the PDF).
  • Note that when you remove the tags (such as by using the Delete Item Structure or Clear Page Structure commands), you cannot undo that action. Save your file often.

6

Once the steps above result in a PDF with no accessibility errors according to Adobe, set the scope of your tables. Adobe does not require you to set the scope but it is one more thing that you can do quickly to prepare your PDFs better for assistive technology.

  1. Select Accessibility > TouchUp Reading Order.
  2. Scroll to your first table and click the number in its upper-left corner.
  3. On the TouchUp Reading Order panel, click Table Editor to select the table.
  4. Select the cells that serve as column headers. You can also repeat these steps for cells that serve as row headers, if your table has that type of structure.
  5. Right-click and select Table Cell Properties.
  6. Keep the Type as Header Cell and from the Scope list, select Column. This tells a screen reader that it is to associate column headers with the cells in that column.
  7. Click OK.

Anchor
characteristics
characteristics
Characteristics of Accessible PDFs

Adobe defines accessible PDFs as having the characteristics in the table below. The table also presents an interpretation of how each characteristic applies to the technical documentation team at CBIIT.

Characteristic of accessible PDFs

How this applies to CBIIT technical writers

Searchable text

Do not scan documents to create a PDF. This converts all text to an image that a screen reader cannot scan.

Fonts that allow characters to be extracted to text

Make sure we only use fonts that can be extracted to Unicode characters. Use Adobe Acrobat 9 rather than 7, which does not support Unicode.

Interactive form fields

We do not use form fields.

Other interactive features: buttons, hyperlinks, and navigational aids

We already use links, bookmarks, headings, and a TOC, so we are covered here.

Document language

We cannot specify the document language from FrameMaker or Word so we must do so in the final PDF.

Security that will not interfere with assistive technology

We should not set any security restrictions on our PDF files. We do not currently do so. The text of an accessible PDF must be available to a screen reader.

Document structure tags and proper read order

When we create a tagged PDF, the structure of our source document should create the appropriate document structure tags. However, while this may create the proper reading order, it does not create the proper order for tabbing through the items on a page. Before running the Acrobat Accessibility Checker, instruct Acrobat to use the document structure for the tab order. Despite our efforts, the Acrobat Accessibility Checker may still report problems with structure; we will have to correct those problems manually or even ignore them, if we cannot determine their cause.

Alternative text descriptions

We must do this in our source files.

Anchor
accessibilitytools
accessibilitytools
Using Accessibility Tools

Both ePublisher and Acrobat contain accessibility tools that help spot glaring accessibility errors and remind us of accessibility issues that require manual checks. Using accessibility tools like these is really just one of the first steps toward Web accessibility.

...

The following table suggests ways you can test your ePublisher, Flare, and PDF output for accessibility. 

Anchor
usingepubreport
usingepubreport
Using the WebWorks ePublisher Accessibility Report

You can use the WebWorks ePublisher Accessibility report to identify accessibility warnings or errors in your online help files.

...

If you are missing any alternate text for your images, add it to your source files, generate your ePublisher project, and view the accessibility report to confirm that you have made your project as accessible as possible.

The Problem with Automated Tools

Credit for the content of the this section belongs to WebAIM.

...

Here is an example. WCAG 1.0 Priority 3 checkpoint 5.5 states, "Provide summaries for tables." Interpreted strictly, this checkpoint could mean, every table in a web page should have a summary attribute. In practice, putting summary attributes into both data tables (which should have summaries) and layout tables (which do not need them) just gives individuals using screen readers more distracting information to read through.

Accessibility Tools Need Human Judgment

Credit for the content of the this section belongs to WebAIM.

It is important to remember that accessibility tools can only partially check accessibility through automation. Of the sixteen standards in Section 508, only seven standards can be partially evaluated automatically. Similarly, of the combined 65 checkpoints in WCAG 1.0 Priority 1 through Priority 3, only nineteen can be partially evaluated automatically. The real key is to learn and understand the web accessibility standards rather than relying on a tool to determine if a page is accessible or not.

Other Resources

Adobe® Accessibility Blog http://blogs.adobe.com/accessibility/2008/03/reference_card_for_accessible.html

...