Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Orion/Accessibility"

(Browser Accessibility and Keyboard Shortcuts)
(Mac)
(32 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
If you get lost and can't figure out where the focus is, maybe you're not drawing the focus ring, or maybe it needs more contrast, or perhaps nothing has focus - which is a fairly serious bug for a keyboard-only user.
 
If you get lost and can't figure out where the focus is, maybe you're not drawing the focus ring, or maybe it needs more contrast, or perhaps nothing has focus - which is a fairly serious bug for a keyboard-only user.
  
After you become more proficient with keyboard navigation and you have ironed out any serious keyboard navigation bugs, start testing with a screen reader. Learn some of the screen reader's keyboard commands.
+
After you become more proficient with keyboard navigation and you have ironed out any serious keyboard navigation bugs, start [http://webaim.org/articles/screenreader_testing/ testing with a screen reader]. Learn some of the screen reader's keyboard commands.
Try listening without looking at the monitor. Think you've got the keyboard aced? Turn off your monitor and see if you can last more than 30 seconds before turning it back on.
+
Try listening without looking at the monitor as you navigate around your page. Does every focusable element have the label and type that you expected? Or is the screen reader saying "button" when an element you consider to be a "menu" gets focus? If you give focus to the "Create a project" text field, does the screen reader say "Create a project; Edit; type in text", or does it just say "Edit; type in text"?
 +
Think you've got this aced? Turn off your monitor and see if you can last more than 30 seconds before turning it back on.
  
 
==Browser Accessibility and Keyboard Shortcuts==
 
==Browser Accessibility and Keyboard Shortcuts==
  
* [http://support.mozilla.org/en-US/kb/Accessibility Firefox shortcuts and accessibility] on all platforms
+
* [http://support.mozilla.org/en-US/kb/Accessibility Firefox] accessibility and shortcuts on all platforms
  
* [http://www.microsoft.com/enable/training/ie9/default.aspx IE9 shortcuts and accessibility], [http://windows.microsoft.com/en-CA/internet-explorer/ie-keyboard-shortcuts#ie=ie-10 IE10 shortcuts], [http://windows.microsoft.com/en-CA/internet-explorer/ie-keyboard-shortcuts#ie=ie-11 IE11 shortcuts]
+
* [http://www.microsoft.com/enable/training/ie9/default.aspx IE9] accessibility and shortcuts, [http://windows.microsoft.com/en-CA/internet-explorer/ie-keyboard-shortcuts#ie=ie-10 IE10] shortcuts, [http://windows.microsoft.com/en-CA/internet-explorer/ie-keyboard-shortcuts#ie=ie-11 IE11] shortcuts
  
* [https://sites.google.com/a/chromium.org/dev/developers/design-documents/accessibility Chrome accessibility], [https://support.google.com/chrome/bin/answer.py?hl=en&answer=157179&topic=25799&rd=1 Chrome shortcuts by platform]
+
* [https://sites.google.com/a/chromium.org/dev/developers/design-documents/accessibility Chrome accessibility], [https://support.google.com/chrome/bin/answer.py?hl=en&answer=157179&topic=25799&rd=1 Chrome shortcuts] by platform
  
 
* [http://www.apple.com/accessibility Apple accessibility], [http://help.apple.com/safari/mac/8.0/#/cpsh003 Safari shortcuts]
 
* [http://www.apple.com/accessibility Apple accessibility], [http://help.apple.com/safari/mac/8.0/#/cpsh003 Safari shortcuts]
Line 31: Line 32:
 
===Windows===
 
===Windows===
  
* [http://www.freedomscientific.com/jaws-hq.asp JAWS] screen reader (search page for Free Demo, which runs 40 minutes then needs reboot) ([http://www.freedomscientific.com/documentation/screen-readers.asp JAWS Documentation] and [http://juicystudio.com/article/making-ajax-work-with-screen-readers.php#screenmodes JAWS Screen Reader Modes])
+
* [http://www.freedomscientific.com/Downloads/JAWS JAWS] screen reader for Windows (free demo runs 40 minutes then needs reboot) ([http://www.freedomscientific.com/Products/Blindness/JawsDocumentation JAWS Documentation] and a good overview article: [http://webaim.org/articles/jaws/ WebAIM JAWS Overview])
  
* [http://www.nvda-project.org/ NVDA] screen reader (free, but requests donation) ([http://www.nvda-project.org/wiki/Documentation NVDA Documentation] and 2 good articles on using NVDA to test web applications in Firefox: [http://www.marcozehe.de/articles/how-to-use-nvda-and-firefox-to-test-your-web-pages-for-accessibility/ Marco's NVDA Overview] and [http://webaim.org/articles/nvda/ WebAIM NVDA Overview])
+
* [http://www.nvda-project.org/ NVDA] screen reader (free, but requests donation) ([http://www.nvaccess.org/files/nvda/documentation/userGuide.html NVDA Documentation] and 2 good overview articles: [http://www.marcozehe.de/articles/how-to-use-nvda-and-firefox-to-test-your-web-pages-for-accessibility/ Marco's NVDA Overview] and [http://webaim.org/articles/nvda/ WebAIM NVDA Overview])
  
* [http://windows.microsoft.com/en-us/windows/hear-text-read-aloud-narrator#1TC=windows-8 Narrator] screen reader for IE10+ in Windows 8 (but not Firefox or Chrome)
+
* [http://windows.microsoft.com/en-us/windows/hear-text-read-aloud-narrator#1TC=windows-8 Narrator] screen reader in Windows 8 for IE10+ (but not Firefox or Chrome) (Note that prior to Windows 8, Narrator was very basic and could only be used for rudimentary accessibility testing)
  
 
* [http://www.microsoft.com/enable/products/windows8/default.aspx Magnifier and other Windows tools] native Windows 8 magnifier, on-screen keyboard, high contrast and speech recognition
 
* [http://www.microsoft.com/enable/products/windows8/default.aspx Magnifier and other Windows tools] native Windows 8 magnifier, on-screen keyboard, high contrast and speech recognition
Line 47: Line 48:
 
===Mac===
 
===Mac===
  
* [http://www.apple.com/accessibility/voiceover/ VoiceOver] screen reader
+
* [http://www.apple.com/accessibility/voiceover/ VoiceOver] screen reader (comes with OS X and iOS; here's a good overview article: [http://webaim.org/articles/voiceover/ WebAIM VoiceOver Overview])
  
* [http://developer.apple.com/library/mac/#documentation/Accessibility/Conceptual/AccessibilityMacOSX/OSXAXTesting/OSXAXTestingApps.html Inspect Objects] (installed with Xcode). Note: with [https://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/WhatsNewXcode/Articles/xcode_4_3.html Xcode 4.3], you need to use <code>Xcode->Open Developer Tool->More Developer Tools...</code>
+
* [https://developer.apple.com/library/mac/documentation/Accessibility/Conceptual/AccessibilityMacOSX/OSXAXTestingApps.html Accessibility Inspector and Accessibility Verifier] (installed with [https://developer.apple.com/xcode/downloads/ Xcode]).
  
 
===Linux===
 
===Linux===
  
* [http://projects.gnome.org/orca/ Orca] screen reader ([http://library.gnome.org/users/orca/stable/ Orca Documentation])
+
* [https://wiki.gnome.org/Projects/Orca/DownloadInstall Orca] screen reader ([https://help.gnome.org/users/orca/stable/ Orca Documentation])
  
* [https://wiki.gnome.org/Apps/Accerciser Accerciser] inspector ([http://developer.gnome.org/accerciser/stable/ Accerciser Documentation])
+
* [https://wiki.gnome.org/Apps/Accerciser Accerciser] inspector ([https://help.gnome.org/users/accerciser/stable/ Accerciser Documentation])
  
 
===Chrome===
 
===Chrome===
Line 62: Line 63:
 
* [http://google-axs-chrome.googlecode.com/svn/trunk/chromeshades_docs/chromeshades_help.html ChromeShades] inspection tool for Chrome browsers shows you visually what a screen reader user would hear
 
* [http://google-axs-chrome.googlecode.com/svn/trunk/chromeshades_docs/chromeshades_help.html ChromeShades] inspection tool for Chrome browsers shows you visually what a screen reader user would hear
  
==Accessible Wiki Documentation==
+
==Automated Testing Tools==
  
Accessible documentation includes making sure that the written text can stand alone without the images. If images are used to convey meaning, then suitable replacement text needs to be supplied.
+
Automated testing tools can find low-hanging fruit, such as missing alt text on images, pages without any headings, or colors that have little to no contrast for some users. However automated testing does not take the place of clean design, user testing, and an understanding of what makes an application accessible.
Alternative text for an image in a wiki follows a vertical bar typed after the image file name, for example: <nowiki>[[Image:Orion-myimage.png|My Alternative Text]]</nowiki>.
+
Exactly what the alternative text should say depends on the context. For example, here are [http://dev.w3.org/html5/alt-techniques/ HTML5: Techniques for providing useful text alternatives].
+
  
Make sure that links have meaningful text. Link text for a link in a wiki follows a space after the link url, for example: <nowiki>[http://www.google.com Google]</nowiki>. Avoid using words like [http://www.google.com here] and [http://www.google.com here] and [http://www.google.com here] and [http://www.google.com more...] and [http://www.google.com more...] as link text because screen reader users rely on the link text to tell them what the link is for.
+
* [http://chrispederick.com/work/web-developer/ Web Developer Plugin] for Chrome, Firefox and Opera
  
==Automated Testing Tools==
+
* [http://www.paciellogroup.com/resources/wat/ Web Accessibility Toolbar (WAT) for Internet Explorer] from The Paciello Group
  
Automated testing tools can find low-hanging fruit, such as missing alt text on images, or pages without any headings. However automated testing does not take the place of clean design, user testing, and an understanding of what makes an application accessible.
+
* [https://addons.mozilla.org/en-us/firefox/addon/accessibility-evaluation-toolb/ Accessibility Evaluation Toolbar for Firefox]
  
* [http://chrispederick.com/work/web-developer/ Web Developer Plugin for Chrome and Firefox]
+
* [http://www.paciellogroup.com/resources/aviewer/ Accessibility Viewer (aViewer)] web accessibility inspector from The Paciello Group
  
* [http://wave.webaim.org/ WAVE Web Accessibility Evaluation Tool]
+
* [http://wave.webaim.org/ WAVE Web Accessibility Evaluation Tool] by WebAIM
  
* [http://www.paciellogroup.com/resources Colour Contrast Analyser (Win/Mac), Web Accessibility Toolbar (WAT) for Internet Explorer, and Accessibility Viewer (aViewer)] from The Paciello Group.
+
* [http://www.paciellogroup.com/resources/contrastanalyser/ Colour Contrast Analyser (Win/Mac)] from The Paciello Group
  
* [http://leaverou.github.io/contrast-ratio/ Contrast Ratio] colour contrast checker.
+
* [http://leaverou.github.io/contrast-ratio/ Contrast Ratio] colour contrast checker
  
 
* [http://usabilitygeek.com/10-free-web-based-web-site-accessibility-evaluation-tools/ List of 10 free web accessibility tools]
 
* [http://usabilitygeek.com/10-free-web-based-web-site-accessibility-evaluation-tools/ List of 10 free web accessibility tools]
  
* [http://www.w3.org/WAI/demos/bad/Overview.html BAD: Before and After Demo] shows a demo web site before and after coding for accessibility.
+
==Accessible Wiki Documentation==
 +
 
 +
Accessible documentation includes making sure that the written text can stand alone without the images. If images are used to convey meaning, then suitable replacement text needs to be supplied.
 +
Alternative text for an image in a wiki follows a vertical bar typed after the image file name, for example: <nowiki>[[Image:Orion-myimage.png|My Alternative Text]]</nowiki>.
 +
Exactly what the alternative text should say depends on the context. For example, here are [http://dev.w3.org/html5/alt-techniques/ HTML5: Techniques for providing useful text alternatives].
 +
 
 +
Make sure that links have meaningful text. Link text for a link in a wiki follows a space after the link url, for example: <nowiki>[http://www.google.com Google]</nowiki>. Avoid using words like [http://www.google.com here] and [http://www.google.com here] and [http://www.google.com here] and [http://www.google.com more...] and [http://www.google.com more...] as link text because screen reader users rely on the link text to tell them what the link is for.
  
 
==Tips of the Day==
 
==Tips of the Day==
Line 97: Line 102:
  
 
==WAI-ARIA==
 
==WAI-ARIA==
 
The [http://www.w3.org/WAI/ W3C Web Accessibility Initiative] is the overarching body that publishes the standards and guidelines for web accessibility.
 
  
 
In order to write Accessible Rich Internet Applications you need to use WAI-ARIA to augment your HTML/Javascript/CSS with semantic information.
 
In order to write Accessible Rich Internet Applications you need to use WAI-ARIA to augment your HTML/Javascript/CSS with semantic information.
 +
 +
The [http://www.w3.org/WAI/ W3C Web Accessibility Initiative] is the overarching body that publishes the standards and guidelines for web accessibility.
  
 
Read the [http://www.w3.org/WAI/intro/aria Introduction to WAI-ARIA] or jump right into the [http://www.w3.org/WAI/PF/aria WAI-ARIA Specification].
 
Read the [http://www.w3.org/WAI/intro/aria Introduction to WAI-ARIA] or jump right into the [http://www.w3.org/WAI/PF/aria WAI-ARIA Specification].
Line 112: Line 117:
 
Follow the [http://www.w3.org/WAI/PF/aria-practices/#aria_ex ARIA Design Patterns] when you are creating custom controls like a dialog, tree, breadcrumb, or toolbar.
 
Follow the [http://www.w3.org/WAI/PF/aria-practices/#aria_ex ARIA Design Patterns] when you are creating custom controls like a dialog, tree, breadcrumb, or toolbar.
  
Here is an [http://www.w3.org/WAI/PF/aria/appendices#quickref ARIA Role, State, and Property Quick Reference].
+
Here is an [http://www.w3.org/WAI/PF/aria/appendices#quickref ARIA Role, State, and Property Quick Reference] showing the states and properties (attributes) supported by each role.
  
For examples of ARIA in Orion, search for <code>aria-</code> or <code>tabindex=</code> or <code>role=</code> in the code.
+
For examples of ARIA, search for <code>aria-</code> or <code>tabindex=</code> or <code>role=</code> in the code.
  
 
==Web Accessibility Links==
 
==Web Accessibility Links==
Line 126: Line 131:
 
* The [https://developer.mozilla.org/en/aria ARIA wiki] is still being developed, but it has some good resources.
 
* The [https://developer.mozilla.org/en/aria ARIA wiki] is still being developed, but it has some good resources.
  
* [https://groups.google.com/forum/#!forum/free-aria Free ARIA] and [http://lists.w3.org/Archives/Public/w3c-wai-ig/ W3C's WAI Interest Group] are email lists that can answer tough questions that google search can't answer.
+
* [http://lists.w3.org/Archives/Public/w3c-wai-ig/ W3C's WAI Interest Group] and [https://groups.google.com/forum/#!forum/free-aria Free ARIA] are email lists that can answer tough questions that google search can't answer.
  
 
* The [http://www-03.ibm.com/able/guidelines/web/accessweb.html IBM web accessibility checklist] and [http://www-03.ibm.com/able/guidelines/documentation/accessdoc.html IBM document accessibility checklist] are both excellent resources providing many examples of ways to improve accessibility.
 
* The [http://www-03.ibm.com/able/guidelines/web/accessweb.html IBM web accessibility checklist] and [http://www-03.ibm.com/able/guidelines/documentation/accessdoc.html IBM document accessibility checklist] are both excellent resources providing many examples of ways to improve accessibility.
Line 134: Line 139:
 
* [http://www.webaxe.org WebAxe] is a web accessibility blog and podcast with news and practical tips.
 
* [http://www.webaxe.org WebAxe] is a web accessibility blog and podcast with news and practical tips.
  
* [http://www.paciellogroup.com/ The Paciello Group] is a good website containing a web accessibility blog and other resources.
+
* [http://www.paciellogroup.com/blog/ The Paciello Group blog] has useful articles on web accessibility.
  
* [http://simplyaccessible.com/archives/ Simply Accessible] and [http://alistapart.com/topic/accessibility A List Apart] are good websites containing many articles on web accessibility.
+
* [http://simplyaccessible.com/archives/ Simply Accessible] contains many good articles on web accessibility.
 +
 
 +
* [http://alistapart.com/topic/accessibility A List Apart] is another good web accessibility blog.
 +
 
 +
* [http://www.w3.org/WAI/demos/bad/Overview.html BAD: Before and After Demo] shows a demo web site before and after coding for accessibility.
  
 
* [https://mikewest.org/2011/12/transcript-gdd-accessibility-with-chromevox Accessibility with ChromeVox] is a good overview talk on web accessibility.
 
* [https://mikewest.org/2011/12/transcript-gdd-accessibility-with-chromevox Accessibility with ChromeVox] is a good overview talk on web accessibility.
Line 149: Line 158:
 
[https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&f1=short_desc&f2=keywords&j_top=OR&o1=allwordssubstr&o2=substring&product=Orion&query_format=advanced&v1=accessibility&v2=accessibility&order=bug_id%20DESC Orion accessibility bug list].
 
[https://bugs.eclipse.org/bugs/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&classification=Eclipse&f1=short_desc&f2=keywords&j_top=OR&o1=allwordssubstr&o2=substring&product=Orion&query_format=advanced&v1=accessibility&v2=accessibility&order=bug_id%20DESC Orion accessibility bug list].
  
If your issue isn't in the list, [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Orion&keywords=accessibility file an Orion accessibility bug].
+
If your issue isn't in the list, [https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Orion&keywords=accessibility file an Orion accessibility bug] (first-time users need to create an account).
  
 
If you know how to fix it, please [[Orion/Contributing_Code|submit a patch]].
 
If you know how to fix it, please [[Orion/Contributing_Code|submit a patch]].
  
 
[[Category:Orion]]
 
[[Category:Orion]]

Revision as of 11:48, 21 May 2015

Testing Web Accessibility

A great accessibility test is to put your mouse out of reach (and/or disable your trackpad) and just use the keyboard for a while. Every time you find yourself reaching for your visual pointing device, stop and think, "Can I do this with the keyboard"? Use Tab and Shift+Tab to navigate between controls (or grouped controls, like radios), arrow keys to navigate within controls (or control groups), and Space or Enter to select or activate. Need a menu? Type Alt. Context menu? Shift+F10. Exit a menu or dialog? Esc. Zoom in/out/restore? Ctrl +, Ctrl -, and Ctrl 0 (or Cmd on Mac). List of keyboard commands in Orion? Shift+? (or Alt+Shift+? from within the editor).

Every platform and every browser has a set of keyboard shortcuts. For platform shortcuts, check out Wikipedia's Table of Keyboard Shortcuts. For browser-specific shortcuts, see the list below. If you can't figure out how to do something with the keyboard, then maybe that something needs to be fixed. If an important function takes too many keystrokes, maybe a key binding - or a refactoring - is needed. If you get lost and can't figure out where the focus is, maybe you're not drawing the focus ring, or maybe it needs more contrast, or perhaps nothing has focus - which is a fairly serious bug for a keyboard-only user.

After you become more proficient with keyboard navigation and you have ironed out any serious keyboard navigation bugs, start testing with a screen reader. Learn some of the screen reader's keyboard commands. Try listening without looking at the monitor as you navigate around your page. Does every focusable element have the label and type that you expected? Or is the screen reader saying "button" when an element you consider to be a "menu" gets focus? If you give focus to the "Create a project" text field, does the screen reader say "Create a project; Edit; type in text", or does it just say "Edit; type in text"? Think you've got this aced? Turn off your monitor and see if you can last more than 30 seconds before turning it back on.

Browser Accessibility and Keyboard Shortcuts

  • Firefox accessibility and shortcuts on all platforms
  • IE9 accessibility and shortcuts, IE10 shortcuts, IE11 shortcuts

Screen Readers and other Assistive Technologies

Screen readers interpret what is being displayed on the screen, and then read the information aloud or send it to a braille display to assist low-vision or blind users. Magnifiers enhance the screen with magnification and highlighting to benefit low-vision users. Inspectors are testing tools that present semantic information to developers.

Windows

  • Narrator screen reader in Windows 8 for IE10+ (but not Firefox or Chrome) (Note that prior to Windows 8, Narrator was very basic and could only be used for rudimentary accessibility testing)
  • AccProbe inspector for Firefox and Chrome
  • Inspect (available with Windows SDK)

Mac

Linux

Chrome

  • ChromeVox screen reader for Chrome browsers on all OS platforms
  • ChromeShades inspection tool for Chrome browsers shows you visually what a screen reader user would hear

Automated Testing Tools

Automated testing tools can find low-hanging fruit, such as missing alt text on images, pages without any headings, or colors that have little to no contrast for some users. However automated testing does not take the place of clean design, user testing, and an understanding of what makes an application accessible.

Accessible Wiki Documentation

Accessible documentation includes making sure that the written text can stand alone without the images. If images are used to convey meaning, then suitable replacement text needs to be supplied. Alternative text for an image in a wiki follows a vertical bar typed after the image file name, for example: [[Image:Orion-myimage.png|My Alternative Text]]. Exactly what the alternative text should say depends on the context. For example, here are HTML5: Techniques for providing useful text alternatives.

Make sure that links have meaningful text. Link text for a link in a wiki follows a space after the link url, for example: [http://www.google.com Google]. Avoid using words like here and here and here and more... and more... as link text because screen reader users rely on the link text to tell them what the link is for.

Tips of the Day

Orion committer Carolyn MacLeod wrote a very useful series of "tip of the day" messages that are a great place to get started with writing accessible web UIs.

  1. Whenever possible, use semantically appropriate HTML elements
  2. Add or augment the semantics of HTML elements with WAI-ARIA
  3. Every focusable element needs a name
  4. Use HTML5 section elements and ARIA landmark roles to semantically organize pages
  5. More on role="application", role="document" and role="presentation"

WAI-ARIA

In order to write Accessible Rich Internet Applications you need to use WAI-ARIA to augment your HTML/Javascript/CSS with semantic information.

The W3C Web Accessibility Initiative is the overarching body that publishes the standards and guidelines for web accessibility.

Read the Introduction to WAI-ARIA or jump right into the WAI-ARIA Specification.

Follow the 13-step process for creating an accessible widget with WAI-ARIA.

Make sure the user can navigate to every focusable control or item with the keyboard. Read section 3.1.2 and 3.1.3 and section 3.2.1 of the ARIA Authoring Practices doc.

Follow the ARIA Design Patterns when you are creating custom controls like a dialog, tree, breadcrumb, or toolbar.

Here is an ARIA Role, State, and Property Quick Reference showing the states and properties (attributes) supported by each role.

For examples of ARIA, search for aria- or tabindex= or role= in the code.

Web Accessibility Links

  • The ARIA wiki is still being developed, but it has some good resources.
  • WebAIM is a good web accessibility resource with articles and links to other resources.
  • WebAxe is a web accessibility blog and podcast with news and practical tips.

Reporting Bugs and Contributing Code

Orion is an open source project. Testing, bug filing/triage, documentation and code contributions to the accessibility support are very welcome and greatly appreciated.

When you run into an issue, check the Orion accessibility bug list.

If your issue isn't in the list, file an Orion accessibility bug (first-time users need to create an account).

If you know how to fix it, please submit a patch.

Back to the top