Using Attest with Assistive Technologies
Deque Systems, Inc. considers NVDA/Windows as the main platform for screen reader users of the WorldSpace Attest browser extension for Chrome. We recommend using NVDA or JAWS on Windows, and VoiceOver on Mac. The initial release (v.1.0) of the Attest extension is designed for use with the Google Chrome browser only. However, support for the Firefox browser is planned for a future release coming soon!
Before You Begin: To view Deque's voluntary product accessibility conformance report for the WorldSpace Attest Extension for the Chrome browser, see WorldSpace Attest Browser Extension for Chrome VPAT.pdf
Using the WorldSpace Attest browser extension for Chrome with NVDA
Chrome DevTools Keyboard Shortcut Reference:
Before you begin, please be aware Google has recently updated (and relocated) their primary Chrome browser Developer Tools (DevTools) user guide and web reference materials. For keyboard shortcuts generally applicable to using Attest in Chrome DevTools, see Keyboard Shortcuts Reference - Google Developers Chrome DevTools.
The instructions that follow generally explain how to use the WorldSpace Attest browser extension for Chrome with Windows-based screen readers such as NVDA. Covered are subtopics for installing, launching, navigating the user interface, adjusting settings, performing an accessibility analysis, and exporting results. It does not cover using the SimulAT or Scripting functionality, nor does it go into the level of detail that the remainder of this user guide does. It is intended to serve as a quick start guide for users of the NVDA screen reader software.
In this topic:
- Installing WorldSpace Attest
- Opening WorldSpace Attest
- Understanding and Navigating the User Interface
- Configuring Settings
- Analyzing a Page for Accessibility Rule Violations
- Working With Analysis Results
- Using Custom Rules
Installing WorldSpace Attest
Installation of the WorldSpace Attest extension for the Chrome browser is slightly different than Deque's FireEyes II extension for the Firefox browser, which has a different installation process for WorldSpace Comply users (who use an install link from the application), than it is for WorldSpace Attest users (who download an .xpi file from a repository first).
Deque Personnel Only: As an Attest extension product user, you should not be responsible for installation. The following instructions are provided to give you an idea of how Deque personnel (Engagement Managers, Customer Success, Help Desk) will handle this for you. The exact procedures are subject to be different than the examples that follow, depending on the relevant security policy, product version, browser type(s) and browser version(s) approved for use at your organization.
From the Chrome Web Store Extensions page
The easiest way to install the WorldSpace Attest DevTools extension for Chrome is via a direct link to its Extensions page in the Chrome Web Store. If you've ever installed any extension in the Chrome browser before, the process is exactly the same. However, the Attest extension is not searchable, so a direct link is needed:
For complete installation instructions using this method, refer to the Downloading, Installing and Configuring the Attest Extension topic in the Getting Started section of this guide.
From an Install Link
The compressed .crx installation file may be provided directly from a link in the right sidebar menu of the WorldSpace Comply that allows you to initiate the installation process from within the Chrome browser.
To install WorldSpace Attest from an install link (Comply):
- Navigate to the Quick Links section of the Home screen in WorldSpace Comply using the Chrome browser.
- Activate the Download WorldSpace Attest Browser Extension 1.0 link.
- Tab over to the Load Unpacked Extension... button and activate it (or press Alt + I).
When you activate the Attest install link you should get a message asking whether you want to install the WorldSpace Attest extension.
From a CRX File
The packed Chrome extension is offered as a compressed file with the .crx file extension, and offers a private key so that you never need to worry about manually updating the extension, as this is handled automatically.
To install WorldSpace Attest from an .crx file (Attest):
- Sign in to Deque Agora, expand the Attest Extension repository from the Artifacts menu, select the 'attest_extension-x.x.x-fx.crx' file, then tab to the Download button and activate it.
- Navigate to the downloaded .crx file on your computer.
- Press Enter to activate it.
Verifying Installation Completion
When installation is complete, a process that should only take a few seconds, you should hear a message that the WorldSpace Attest extension was installed successfully. You can always verify whether installation was successful by trying to open the WorldSpace Attest extension from the developer tools. For more information, see Opening WorldSpace Attest below. However, the following steps guide you to verify the installation by finding WorldSpace Attest on the Chrome Extensions page.
To verify the installation process completed:
- In the Chrome Address (Location) field, type chrome://extensions/ and then press Enter.
- Tab three tab stops to the list of installed Chrome extensions.
- Arrow down to locate an entry for WorldSpace Attest DevTools.
- Listen for the options "disable, remove". When you hear them announced after WorldSpace Attest, the extension is installed and ready to use.
Note: The list items are typically displayed in ascending recently-installed order, so it should be the first entry.
Opening WorldSpace Attest
The WorldSpace Attest extension is located in the Chrome DevTools toolbox tab bar.
To open the WorldSpace Attest extension from Chrome:
- Press and hold Ctrl+Shift+I to launch Chrome DevTools.
- Press and hold Ctrl + ] until you hear "WorldSpace Attest."
- With focus on "WorldSpace Attest", press Enter.
Note: When first installed in Chrome where no other extensions that integrate with Chrome DevTools have previously been installed, it is typically the far, right tab, which is approximately the 9th tab from left.
WorldSpace Attest is now open in Chrome and ready to use.
Understanding and Navigating the User Interface
Main Menu Panel Selection
On the left pane of Attest, regardless of which panel is currently selected, you have a main drop-down menu that provides links to each of the 5 main panels within Attest.
- With the WorldSpace tab selected, press the Tab key to focus on the Main Menu, which will be read as "global navigation."
- With focus on the global navigation "main menu," press the Enter key.
Note: The frame is announced as "data/index" frame.
Default Tab: After signing in to WorldSpace Comply on the Settings pane, the Analyze pane is active by default when you open WorldSpace Attest. This is the tab used to perform accessibility analysis, and is likely to be the tab you will be using 99.5% of the time.
The WorldSpace Attest main menu reveals the following 5 panel items:
- Analyze: Selected by default when WorldSpace Attest is opened. Refer to the Analyzing a Page for Accessibility Rule Violations heading below for JAWS-specific instructions about using this tab. For additional details, see the Analyze user guide topic.
- Scripts: For complete details, see the Scripts user guide topic.
- SimulAT: For complete details, see the SimulAT user guide topic.
- Rules: Refer to the Using Custom Rules heading below for JAWS-specific instructions about using this pane. For additional details, see the Rules user guide topic.
- Settings: Refer to the Configuring Settings heading below for JAWS-specific instructions about using this tab. For additional details, see the Settings user guide topic.
The menu closes and is announced as "button collapsed," followed by the name of the menu item you selected.
Panel-Specific Context Menu (Analyze menu)
Some panel-specific controls and links to associated panels or related functionality on other panels for the selected panel are accessed via an ellipses button drop-down menu at the top bar of the right content pane in the Analyze panel. Visually, this button appears as three vertical dots and is sometimes informally referred to as a "three-dot menu."
To use the Analyze panel "context" menu:
- Tabbing from the Analyze button on the Analyze panel, for example, will focus next on what will be announced as the "main landmark Analyze google menu button collapsed."
- With focus on the collapsed Analyze menu button, press the Enter to reveal the menu items.
- Arrow down to highlight a menu item, then press Enter to select it, as desired.
Each panel within Attest is made up of 2-3 panes of information, themselves sometimes containing multiple sections of information under headings.
To switch to other panes, do either of the following:
- In browse mode, arrow up or down to the pane you want, then press Enter.
- In forms mode, tab to the active pane and then use the arrow keys (right or left) to switch to other panes (no Enter necessary).
Note: When you do this, you need to force NVDA back to browse mode by pressing the NVDA key and space bar.
Keyboard Layout and Forms Mode
NVDA Keyboard Layout: To get out of forms mode in NVDA, press the Esc key or the NVDA key and spacebar. Note: The NVDA key is the insert key, unless you change to CapsLock, which you can do in the NVDA configuration menu.
Selecting a Rule Set
You may want to adjust the Rule Set option on the Rules panel. The Rules panel consists of checkboxes with the legend "Ruleset," in which three sets of rules may be found. The WCAG 2.0 AA rules are active by default. Using a rule set other than the WCAG 2.0 AA default involves making optional adjustments on the Rules tab.
You can perform off-line analysis using one of the WorldSpace Attest standard rule sets without connecting to a WorldSpace Comply server, or you can use your own custom rule set. For complete details, see the Custom Rules topic within this guide.
Default Standard: If you use WorldSpace Attest out of the box you will perform a WCAG 2.0 AA analysis using the default WCAG 2.0 AA rule set.
To select a rule set:
- Press R in NVDA.
- Select the checkbox for the desired rule set to activate it.
You will notice that the WCAG 2.0 level AA checkbox is checked by default. This is the standard rule set that ships with WorldSpace Attest and is used until you tell WorldSpace Attest to use a different one. You cannot delete rule sets that come with WorldSpace Attest.
No further confirmation is necessary.
Settings: Server Connection, Project Selection, and Scope
The first thing you will notice in the Settings panel is a set of form fields that enable you to connect WorldSpace Attest to a WorldSpace Comply server. After signing in to Comply, a Project Selection menu with button appears. After selecting a Project, two new sections appear: Download Issues and Scope.
You may want to connect to your WorldSpace Comply server and select a project to enable download and upload of analysis results. If WorldSpace Attest is not connected to a WorldSpace Comply server, the dropdown is announced as "offline no project" or "clickable offline no project clickable", and the Project Selection functionality is announced as "unavailable". For complete details, see Signing In to WorldSpace Comply and Selecting a WorldSpace Comply Project respectively.
Before performing an analysis on the Analyze panel, you may want to adjust the options in the Scope section of the Settings panel to refine what will be targeted or ignored. For complete details, see Scope Definitions.
Event Recording Options
The Script Recording Options pane accessed via the Options link on the Scripts tabpanel has a section called "Events to Capture". It consists of a number of checkboxes where you can configure which events are recorded or ignored when recording scripts. For more information, see Selecting Events to Capture.
Analyzing a Page for Accessibility Rule Violations
To analyze a page for accessibility violations:
- Open the page you want to test in Chrome.
- Open Chrome DevTools (Ctrl+Shift+I) and select the WorldSpace tab.
- Locate the ANALYZE button or Run again link (if the first analysis has already been performed on the page) in the WorldSpace Attest Analyze pane (it doesn't matter which you select, they both perform the same function).
- Activate the button.
Refer to the Opening WorldSpace Attest heading above on this page for more information if necessary.
The button's label will change to "analyzing" while a scan is going on, and then to "Analyze" when the scan is completed.
You know that the scan is finished if you can arrow or tab down from the "Analyze" button.
When No Accessibility Violations Are Found
If no accessibility violations were found, the line after the "upload button" should read: "Congratulations! No accessibility violations found. Now you should perform manual testing using assistive technologies like NVDA, VoiceOver and JAWS."
Working With Analysis Results
Export button and violations count: If one or more errors were discovered, the fifth link option in the Analyze panel menu is named "Export". It is used to export the results to a .csv file.
Download and Upload links: Also in the Analyze panel menu are link items named "download..." and "upload...". They will be announced as "disabled" when not connected to a WorldSpace Comply server. For more information, see Uploading Analysis Results and Downloading Page Issues from WorldSpace Comply.
There are two ways to work with WorldSpace Attest analysis results. One is to export them and then use a spreadsheet program. The other is to review them from within the Analyze panel itself.
When you want to work with analysis results in a spreadsheet program such as Excel which allows for sorting and other data manipulation, you can activate an Export link from the WorldSpace Attest Analyze menu to download a Comma-Separated Value (CSV) file that can be opened by such a program. This is particularly helpful to screen reader users to aid in easy navigation between violations when the results include multiple violations of multiple rules.
To export results to a CSV file:
- Activate the Export link, which appears as the 4th link in the panel-specific Analyze drop-down menu when violations were found as a result of the analysis.
- Select a convenient folder, give the file a descriptive name, and save it.
A typical Save File dialog box appears.
Note: The first time you bring up the "Save File" dialog using the "Export" link, make sure to select the desired folder by shift-tabbing to the folder tree. By default WorldSpace Attest saves the exports in the default download location configured in your Chrome browser settings. After you select a folder once, WorldSpace Attest will remember your folder selection for future exports.
Reviewing Results In WorldSpace Attest
All WorldSpace Attest results are displayed under the "Violations found" h2 heading. This is usually the only heading on the Analyze panel, so using "h" should get you there directly.
To review rule violations:
- Press the up arrow 2 times to see the line where the number of violations found is reported.
WorldSpace Attest displays an ordered list of tests where violations were found, along with the number of violations for each rule. The rule names in the list are links that when activated show a list of all violations for that rule.
A typical list of violations could look like:
"list of x items" 1 Link: Elements must have sufficient color contrast x violations (where x is the number of violations). 2 Link: id attribute value must be unique violations ...
To drill down to individual violations:
- Activate the rule link in the list.
Once you have activated a rule link, you will see a panel displaying the first violation for that rule.
Analysis Results Violation Panel Overview
This section describes the sequential information you will encounter as you arrow down within an individual rule violation.
Displaying an Individual Violation: Start at the list of rules that produced violations (see previous section for a description and example of what that list looks like).
Multiple Violation Navigation and Impact
Previous button: At the end of that list you will see a button called "previous". It is disabled when you are viewing the first violation of the rule.
# of Total Violations: Arrowing down from the Previous button you will see a line that reads: "violation 1 of x" where x is the total number of violations under the active rule.
Impact: Arrowing further down from that line you will see a line containing the word "impact". The following line will contain the impact rating: One of "minor, moderate, serious, or critical."
Next button: Then you will see the "next" button. If you are on the last violation for a particular rule, the "next" button is announced as disabled.
Description: Arrowing down from the "next" button you will see a one-line description of the rule that is being violated along with a "More info" link. As an example, for a violation of the color contrast rule, this line will read "Ensures the contrast between foreground and background colors meets WCAG 2 AA contrast ratio thresholds."
More info link: The "More info" link takes you to Deque University where you can uncover a lot of context and background info about the violated rule, in addition to detailed "how to fix" information.
Applicable Rule Set (Standard) and Success Criteria: Next you will find a list of 2 items. The first list item contains the active rule set used in the scan. By default this is WCAG 2.0 AA, noted as "wcag2aa". The second list item specifies the success criterion for the active rule (for example, wcag143 for WCAG 2.0 success criterion 1.4.3 - color contrast).
Inspect and Highlight links: The "Inspect" link highlights the element in DevTools. The second link "Highlight" visually highlights the webpage element in the Chrome window.
Section Navigation: Several additional h2 headings represent sections of the content pane within a violation:
Target: The next h2 heading is "target". Underneath it you will find a CSS selector path to the html element where the violation was detected.
HTML: The following h2 heading is "html". Underneath it you will find a snippet of HTML code including the element where the violation was found.
Summary: The last h2 heading has the text "summary". Underneath it is an h3 heading with the text "fix any of the following" followed by a list of suggested fixes. The precise layout and wording of the suggested fix depends on the violation, but it is important to include this text in any report or analysis, as it usually helps to pinpoint the exact error and often provides the easiest fix.
Multiple Violation Navigation Notes
Using Previous and Next buttons: If there is more than one violation of a rule, you can use the "previous" and "next" buttons to go to the previous/next violation. When you activate the "previous" or "next" buttons, the updated "violation x of y" line is announced automatically by most screen readers. Assuming you were looking at violation 1 of 10 and press the next button, NVDA should automatically announce "violation 2 of 10". There is no way to quickly navigate to a particular violation for a rule other than using the "next" and "previous" buttons.
Navigation to an individual violation: In order to get to violation 8 of 10 for rule x, you have to click rule x and then click the "next" button 7 times.
About the last violation: Pressing the "next" button for the last violation of a given rule does not automatically advance to the first violation of the next rule. In fact, the "next" button is disabled once you get to the last violation for a rule. You have to navigate back to the list of rules and activate the next rule you want to inspect. That action will bring up the first violation for that rule as previously described.
Repeat until you have gone through all accessibility violations for all rules. If you want to quickly review all the violations in one place, it is best to export the findings to a .csv file, open it in Excel and work from there.
Using Custom Rules
The "Rules" pane is the 4th in the main menu. If you have written a JSON file of custom rules that you wish WorldSpace Attest to scan for, you use this pane to add that rule set. Then you can select it from the Rules tab. The Custom Ruleset pane contains two form fields (Name for Custom Rules and Enter JSON) and a SAVE AND USE RULESET button.
To add custom rules:
- Specify a name for your custom rule set in the first input field.
- Enter (or rather paste in) your JSON rules in the second field.
- Activate the SAVE AND USE RULESET button.
Make sure it only contains letters or numbers (no spaces, dashes or other symbols are allowed as part of the rule set name).
You will either get a "success" message, or an error message if you specified an invalid name or used invalid JSON format. If your rule set was successfully saved, you can see its name in the Custom rulesets section of the left sidebar menu on the Rules pane, from which you can activate it. You can delete a custom rule set by first selecting its corresponding checkbox and then activating the "Delete rule set" button.
For more detailed information about creating and using custom rules, refer to the Custom Rules user guide topic.