This feature is supported in Adobe PDF, WebHelp, WebHelp Plus, WebHelp AIR, and WebHelp Mobile output.
Accessibility has to do with making sure that your documentation can be accessed by people with disabilities (i.e., individuals who have visual, hearing, and mobility impairments). Documentation is considered accessible when it is easier for those with disabilities to use and easier to read using assistive technologies such as Microsoft Windows Narrator, Connect Outloud, and JAWS (Job Access With Speech).
The two primary Web accessibility standards are:
Section 508 and WCAG, although similar, are not the same thing. In the United States all Federal agencies by law must comply with Section 508. On the other hand, WCAG is a set of recommendations for making Web content accessible.
Following are standards and guidelines outlined by Section 508 and WCAG. As you can see, there are some similarities between the lists.
| Section 508 | WCAG |
|---|---|
|
A text equivalent for every non-text element shall be provided (e.g., via "alt", "longdesc", or in element content). Equivalent alternatives for any multimedia presentation shall be synchronized with the presentation. Web pages shall be designed so that all information conveyed with color is also available without color, for example from context or markup. Documents shall be organized so they are readable without requiring an associated style sheet. Redundant text links shall be provided for each active region of a server-side image map. Client-side image maps shall be provided instead of server-side image maps except where the regions cannot be defined with an available geometric shape. Row and column headers shall be identified for data tables. Markup shall be used to associate data cells and header cells for data tables that have two or more logical levels of row or column headers. Frames shall be titled with text that facilitates frame identification and navigation. Pages shall be designed to avoid causing the screen to flicker with a frequency greater than 2 Hz and lower than 55 Hz. A text-only page, with equivalent information or functionality, shall be provided to make a web site comply with the provisions of this part, when compliance cannot be accomplished in any other way. The content of the text-only page shall be updated whenever the primary page changes. When pages utilize scripting languages to display content, or to create interface elements, the information provided by the script shall be identified with functional text that can be read by assistive technology. When a web page requires that an applet, plug-in or other application be present on the client system to interpret page content, the page must provide a link to a plug-in or applet that complies with §1194.21(a) through (l). When electronic forms are designed to be completed on-line, the form shall allow people using assistive technology to access the information, field elements, and functionality required for completion and submission of the form, including all directions and cues. A method shall be provided that permits users to skip repetitive navigation links. When a timed response is required, the user shall be alerted and given sufficient time to indicate more time is required. |
Text Alternatives: Provide text alternatives for any non-text content so that it can be changed into other forms people need, such as large print, braille, speech, symbols or simpler language. Time-based Media: Provide alternatives for time-based media. Adaptable: Create content that can be presented in different ways (for example simpler layout) without losing information or structure. Distinguishable: Make it easier for users to see and hear content including separating foreground from background. Keyboard Accessible: Make all functionality available from a keyboard. Enough Time: Provide users enough time to read and use content. Seizures: Do not design content in a way that is known to cause seizures. Navigable: Provide ways to help users navigate, find content, and determine where they are. Readable: Make text content readable and understandable. Predictable: Make Web pages appear and operate in predictable ways. Input Assistance: Help users avoid and correct mistakes. Compatible: Maximize compatibility with current and future user agents, including assistive technologies. |
Alt and Title Attributes (Alternative Text and Screen Tips)
How do you make your output accessible? You can accomplish much of the work by making sure you have "alt" and "title" attributes on your various elements—such as links, images, forms, and multimedia. These two attributes, although similar, are not identical.
An "alt" attribute is intended to provide alternative information for elements that cannot be seen (e.g., visually impaired individuals cannot see pictures in your output). The "alt" attribute text should briefly describe what the element is about.
On the other hand a "title" attribute is created when you add screen tip (or tool tip) text for an element. The "title" attribute text should provide additional information about the element.
Following are the different types of elements for which you can set "alt" and/or "title" attributes.
| Element | Alt Attribute (Alternate Text) | Title Attribute (Screen Tip) | Relevant Topics |
|---|---|---|---|
|
Audio (links and embedded) |
. |
|
|
|
Controls (e.g., buttons, labels, input boxes) |
|
|
|
|
Cross-references* |
|
|
|
|
Equations |
|
|
|
|
Image hyperlinks |
. |
|
|
|
Image maps |
. |
|
|
|
Images |
|
|
|
|
Movies (links and embedded) |
. |
|
Inserting Mimic Movie Links into Topics Inserting Mimic Movie Links into Browse Sequences |
|
QR codes |
|
|
|
|
Table of contents (TOC) icons |
|
. |
|
|
Text hyperlinks* |
|
|
|
|
Toolbar items |
|
|
|
|
Topic popups |
. |
|
|
|
* When you add a screen tip a <title> tag is created in the markup. If you insert cross-references or text hyperlinks, an <alt> (alternate text) tag is also added automatically with the same text. |
|||
In addition to the "alt" and "title" attribute tasks listed in the table above, here are some other tasks that you can perform in the Flare interface for helping to make your output accessible.
Note: In addition to these tasks, which can be performed in the Flare user interface, you can accomplish a multitude of other tasks by working directly in the XHTML markup (via the Internal Text Editor or another editor such as Notepad). For example, you can add labels on forms or titles on frame elements that you create. The w3.org website in particular provides a great deal of additional information and techniques for making documentation accessible by editing the markup. See http://www.w3.org/TR/WCAG20-TECHS/.
Note: If an individual is using JAWS to access your Help system, that person needs to be in Forms mode in JAWS in order to navigate successfully in the output.
If you are generating any of the WebHelp output formats (WebHelp, WebHelp Plus, WebHelp AIR, WebHelp Mobile), the runtime and navigation are Section 508 compliant. This helps to ensure your output's adherence to item 1194.22 of the Section 508 specification..
There is a Warnings tab in the Target Editor for WebHelp outputs. The options in this tab let you indicate whether you want to receive compiler warnings when your output fails to include information that makes it accessible.
You can receive warnings when:
Note: If you also have the latest version of MadCap Analyzer installed, you can see these same warnings before you generate output.
If you receive one or more of these types of compiler warnings, what should you do? That depends on the type of warning you receive.
Image elements If you receive this type of warning, you can fix the issue by editing the image and entering a description in the Alternate Text field.
Tables If you receive this type of warning, you can fix the issue by editing the table properties and entering caption text (above the table) and/or adding a header row.
Form elements If you receive this type of warning, you can fix the issue by opening the markup for the document and adding a label to the form. To edit the markup, you can use the Internal Text Editor or Notepad. For more information about working with form elements (and labels within them), see w3.org.
Frame elements If you receive this type of warning, you can fix the issue by opening the markup for the document and adding a title to the frame element. To edit the markup, you can use the Internal Text Editor or Notepad. For more information about working with frame elements (and titles/names within them), see w3.org.
Improved PDF accessibility helps ensure that PDFs generated by Flare are as accessible as possible to users with disabilities.
When you generate a PDF, the following help make the output more accessible.
PDF tagging You can select an option on the PDF Options tab of the Target Editor to generate a tagged PDF. This gives the file a structure similar to that of the source XHTML documents. This structure is necessary for certain accessibility applications, including screen readers. For more information about viewing the tag structure in Adobe Acrobat Pro, please refer to the documentation provided with that application.
Note: If you enable this feature, the size of the PDF output may increase somewhat. Compilation time should not be significantly affected.
Similar to WebHelp output, there is a Warnings tab in the Target Editor for PDF outputs. The options in this tab let you indicate whether you want to receive compiler warnings when your output fails to include information that makes it accessible.
You can receive warnings when:
Note: If you also have the latest version of MadCap Analyzer installed, you can see these same warnings before you generate output.
If you receive one or more of these types of compiler warnings, what should you do? That depends on the type of warning you receive.
Image elements If you receive this type of warning, you can fix the issue by editing the image and entering a description in the Alternate Text field.
Tables If you receive this type of warning, you can fix the issue by editing the table properties and entering caption text (above the table) and/or adding a header row.
When you insert or edit an image, you will see a check box that allows you to apply the same alternate text and screen tip for all instances of the image throughout your project.
|
PDF Downloads: |
MadCap Software, Inc. 7777 Fay Avenue La Jolla, California 92037 Tollfree 1-888-MadCap1 Tel 858-320-0387 Fax 858-320-0338
For technical support: http://madcapsoftware.com/support/
Copyright 2011 MadCap Software |
See Also