Latest revision as of 14:29, 11 May 2011

CKEditor is compliant with several accessibility standards, including the Web Content Accessibility Guidelines (WCAG), the US Section 508 Amendment to the Rehabilitation Act of 1973 and the IBM Web Accessibility Checklist.

CKEditor 3.x is designed to support users with disabilities. You can use it with your mouse, but also with the keyboard as well as a screen reader. The currently supported screen reader solution is JAWS with Firefox 3.6 or Internet Explorer 8.

Basic Navigation

• Tab and Shift+Tab

  Allow you to move into and out of the editor window from other form elements. For supported browser and screen reader solutions the editor should behave just like any other form element with respect to Tab and Shift+Tab key presses.

  One exception to this rule is when config.tabSpaces is set to a non-zero value. In this case, if you press the Tab key while inside the editor window, spaces will be inserted into the text in the editing area, and the focus will not be moved out of the editing area. The Shift+Tab keyboard shortcut would still work as expected though, even when config.tabSpaces is set to a non-zero value.

• Alt+F10

  Moves the focus to the editor toolbar when the cursor is in the editing area.

• Shift+F10

  Opens the context menu of an element inside the editing area.

• Alt+F11

  Moves focus to the elements path usually located at the bottom of the editor. While the elements path is in focus, pressing the Tab and Shift+Tab keyboard shortcuts will select HTML elements that are parents of the current element. Pressing Esc moves the focus back to the editing area without changing selection. Pressing Enter, on the other hand, selects the element chosen in the elements path in the editing area.

Navigating Toolbar

• Tab and Shift+Tab

  Once the toolbar is in focus after you press Alt+F10, Tab and Shift+Tab will move focus forward and backward among the toolbar button groups. Toolbar button group focus is cyclic, so going backwards from the first item will put focus to the last item, and vice versa.

• Left Arrow and Right Arrow

  The Left Arrow and Right Arrow keys will move focus forward and backward among the toolbar buttons within a group, respectively.

• Enter and Space

  Activate a selected toolbar feature.

• Esc

  Puts the focus back to the editing area without executing any commands.

The accessibility shortcuts for toolbar navigation were modified in CKEditor 3.6, when the concept of a toolbar button group was initially introduced. On entering the toolbar you can now use the Tab and Shift+Tab shortcuts to navigate between button groups and the Arrow keys to navigate between the buttons within a group. In CKEditor 3.5.x and before both Tab and Arrow keys were used to navigate between the toolbar buttons.

Navigating Dialog Windows

• Tab and Shift+Tab

  When dialog window tabs are not in focus, these keyboard shortcuts move focus among input element of the dialog window. When a dialog window tab is in focus, Tab and Shift+Tab cycle through dialog window tabs.

  Focus order in dialog windows is cyclic, so when the first tab or first input element is in focus, and the Shift+Tab shortcut is pressed, the last tab or last input element will be selected. Dialog window buttons count as input elements as well.

• Left Arrow and Right Arrow

  When a dialog window tab is in focus, the Left Arrow and Right Arrow keys can be used to cycle between tabs just like Tab and Shift+Tab.

• Alt+F10

  Puts the tab list in focus, selects the currently active tab, and lets you move to the next or previous one with the Tab/Right Arrow or Shift+Tab/Left Arrow keys when inside the dialog window.

• Enter

  Pressing Enter while inside the dialog window, when a single-line text input is in focus, is equivalent to pressing the OK button.

  Pressing Enter while inside the dialog window, when a dialog window tab is in focus, puts the focus back to the first input element inside that tab.

• Esc

  Pressing Esc while inside the dialog window is equivalent to clicking the Cancel or Close buttons.

Navigating Context Menus

• Tab, Shift+Tab

  When the context menu is open, press Tab to cycle through menu items forward or Shift+Tab to cycle backwards.

• Down Arrow and Up Arrow

  When the context menu is open, the Down Arrow and Up Arrow keys can be used to cycle between menu items just like Tab and Shift+Tab, respectively.

• Right Arrow and Left Arrow

  When the context menu item contains a submenu, the Right Arrow lets you enter the submenu. To return to the parent context menu, use the Left Arrow.

• Enter and Space

  Activate a menu item or open a submenu.

• Esc

  Closes a context menu without executing any command. When inside a submenu, closes the submenu and returns focus to the parent context menu. Press Esc again to close it.

Navigating Toolbar Drop-down Lists

• Down Arrow, Enter, and Space

  Enter the drop-down list once it is selected on the toolbar.

• Tab, Shift+Tab

  When the drop-down list is open, press Tab to cycle through list items forward or Shift+Tab to cycle backwards.

• Down Arrow and Up Arrow

  When the drop-down list is open, the Down Arrow and Up Arrow keys can be used to cycle between list items just like Tab and Shift+Tab, respectively.

• Enter and Space

  Activate a feature selected from the drop-down list and put the focus back to the editing area.

• Esc

  Closes a drop-down list without introducing any changes.

Navigating Color Selection Boxes

• Down Arrow, Enter, and Space

  Enter the color selection box once it is selected on the toolbar.

• Tab, Shift+Tab

  When the color selection box is open, press Tab to cycle through colors forward or Shift+Tab to cycle backwards.

• Down Arrow and Up Arrow

  When the color selection box is open, the Down Arrow and Up Arrow keys can be used to cycle between colors just like Tab and Shift+Tab, respectively.

• Enter and Space

  Apply the selected color from the selection box and put the focus back to the editing area.

• Esc

  Closes a color selection box without introducing any changes and puts focus back to the toolbar.

Editor Hotkeys

Many functions in CKEditor have their equivalent keyboard shortcuts. The Keyboard Shortcuts article contains a full list of editor hotkeys along with some common text editing shortcuts, grouped by problem areas.

JAWS

JAWS is a popular screen reader whose aim is to make computer content accessible to blind and visually impaired users. CKEditor fully supports JAWS when used in conjunction with Firefox 3.6 and Internet Explorer 8 browsers.

Editing Mode vs. Non-editing Mode

JAWS distinguishes between editing mode and non-editing mode for text boxes and rich text areas. When JAWS is entering the editing mode, a high pitched 'pop' sound is played to notify the user of the mode switch. Similarly, when JAWS is entering the non-editing mode, a lower pitched 'pop' sound is played.

It is up to JAWS to decide whether to put a text box or a rich text area to editing mode on the initial focus. When it so happens that JAWS has put the initial focus to CKEditor in non-editing mode, you will find that you cannot type in the editor, and no 'pop' sound is played when focus was put into the editing area.

To fix that, press the Enter key once to switch JAWS to the editing mode, and a high pitched 'pop' sound should be played. Pressing Esc inside CKEditor will switch JAWS to the non-editing mode, along with a lower pitched 'pop' sound to indicate the mode switch.

Refreshing the Virtual Cursor

JAWS keeps an internal model of the browser's view, and along with it, a virtual cursor, to facilitate reading of the contents in a Web browser. However, the internal model kept by JAWS is not always in sync with the contents displayed in the browser window. This is especially true for dynamically generated web contents written in JavaScript that CKEditor depends on.

When JAWS's virtual cursor is out-of-sync with the contents displayed in the browser, you will be unable to move correctly among the contents of the web page. You will also find that JAWS's voice is reading out unpredictable garbage from the Web browser — e.g. it may be reading out the raw HTML code in the website, or it may be reading out the same element over and over despite the user's actions to move the virtual cursor away from that element.

To refresh JAWS's internal model and to keep the virtual cursor back in sync with the browser, you will need to press the Insert+Esc keyboard shortcut. In cases where even the Insert+Esc combination fails to refresh JAWS's virtual cursor correctly, you can press the Insert+Z shortcut twice, slowly, to disable and re-enable the virtual cursor.

There are a few problem areas in using CKEditor where JAWS will get out-of-sync with the contents of the browser window:

• When an editor is newly created in the middle of a browsing session.
• When a dialog window is opened.
• When a dialog window is closed.
• When a context menu is opened.
• When a drop-down list is opened.

In all of the above events, it is recommended to press the Insert+Esc shortcut to keep JAWS's virtual cursor in sync with the browser display.

Arrow Keys

When the virtual cursor mode of JAWS is on, Arrow keys have a special meaning. If JAWS is opened and is running in the virtual cursor mode, Arrow hotkeys (like Left Arrow and Right Arrow used for cycling through toolbar items) will cease to work. If this is the case, use equivalent hotkeys like Tab and Shift+Tab.