DRAFT WProofreader keyboard navigation

WProofreader is a multilingual proofreading tool for web applications. It enables grammar and spell check combining spelling and grammar suggestions while you type or work with your text in a dedicated dialog.

WProofreader meets the accessibility standards of the Web Content Accessibility Guidelines (WCAG), in particular WCAG 2.1, and also Section 508. Thus, all web application users, regardless of the limitations they might be facing, can access the main WProofreader features via a keyboard only, thus interacting with it can be more effective and easier. 

Below is an overview of the keyboard commands you can use to proofread your texts, navigate between the spelling and grammar suggestions, add words to a personal user dictionary, and customize WProofreader settings. 

Proofreading your text while you type

As you type your text in a web app with integrated WProofreader, it tries to suggest grammar and spelling suggestions for you on-the-fly and shows the number of discovered issues in the badge in the lower-right part of the editor screen. If no spelling issues are found, the badge shows the tick sign inside. 

The total number of issues found is displayed in the badge.

Accessing more features

The badge in the lower-right part of the editable area shows the number of errors on page and allows to access more options: 

• proofread your text in a dialog, 
• change WProofreader options (ignore cases),
• create and manage a personal dictionary, and add words to it, 
• change the language for checking.

To access more commands and WProofreader dialog in as you type mode, navigate to the badge using Tab. As you navigate to the badge, a circle appears around the number of found issues.

The badge button is in the focused state.

Press Enter or Space to open the badge and access such options as Proofread in a dialog mode, Settings dialog or Disable/Enable WProofreader.

The badge menu with the Settings icon highlighted.

If enabled, there can be also a language selector icon present on the badge. The list of languages available can be open using Enter or Space. To confirm the selection of a language, use Enter or Space as well.

The badge view with Language picker enabled.

Use the commands in table below to access more WProofreader options. 

Proofreading in a dialog

To access Proofread in dialog from as you type dialog: 

1. Press the Tab key to highlight the badge and then press Enter or Space to display the badge actions. 
2. Press the Left/Right arrow key to navigate to the Proofread in dialog icon and press Enter or Space.

Use the commands in table below to check your text, namely, view and accept or reject the grammar and spelling suggestions, and add words to a personal dictionary.

When a problem is active, and you use Up or Down arrow keys, you can navigate to Add word and Ignore all buttons and add a word to a personal dictionary or ignore the issue respectively.

The view of the Proofread in dialog mode.

Settings 

You can access and change WProofreader settings in the Settings dialog. To access this dialog from the as you type mode:

1. Press the Tab key to highlight the badge and then press Enter or Space to display the badge actions. 
2. Press the Left/Right arrow key to navigate to the Settings icon and press Enter or Space to open the Settings dialog.

The WProofreader badge. The Settings icon is selected.

You can alternatively access Settings while proofreading your text in a dialog. To do so, press Tab continuously until you focus on the Settingsicon and it gets highlighted and then press Enter or Space.

The WProofreader dialog. The Settings icon is selected in the top-left corner.

Options

To access and modify WProofreader options: 

1. Press the Tab key until the Options section is selected. Then press Enter or Space and again Tab to navigate to the options area.

2. Use the Tab / Shift+Tab keys to navigate to the desired option and then press Space to select or deselect the desired option. The changes are applied automatically.

The Settings dialog with the Options tab selected.

To change the options of the selected Options dialog group, use the commands in table below. 

The Options tab. Ignore words with mixed case was selected.

Languages

To specify the currently used language for proofreading (spelling and grammar check): 

1. Open Settings dialog. 
2. Press Tab and Enter or Space to select Options first and then repeatedly press the Down arrow key until the Languages section is selected. Then press Enter or Space and again Tab.
3. Use the Up/Down keys to navigate to and select the desired language. The changes are applied automatically.
4. Press Escape to exit the dialog. 

The Languages tab is selected.

Dictionaries 

Use the Dictionaries settings to create a new dictionary or connect an already existing one, and also add or remove the words from the dictionaries.

The Dictionaries tab is selected.

To create a new personal user dictionary or connect to the already existing one:

1. Open Settings dialog.
2. Press Tab and Enter or Space to select Options first. Then repeatedly press the Down arrow key until the Dictionaries section is highlighted and then press Enter or Space.
3. Press Tab to navigate to the Enter a dictionary name field and type a dictionary name then press Tab to select either Connect or Create buttons respectively. Depending on an action made either a new dictionary is created or an already existing one is connected.
   

The Dictionaries tab. A new dictionary is created.

To add a new word to a personal user dictionary: 

1. In the Enter a new word area, type the desired word.
2. Press Enter or press Tab to navigate to the Add word button and press Enter or Space to confirm the action. You will see a pop-up message confirming that the word is added to the dictionary.

Adding a word to the dictionary.

To delete the already existing words from the dictionary: 

1. Press Up/Down arrow keys to navigate to the desired words, select the desired word. As you move between the words, the Binicon is highlighted near the selected word.
2. Press Enter button. The word is deleted from the dictionary, and the notification appears in the lower part of Settings dialog.

To rename a dictionary: 

1. Press the Tab continuously to select the Renameicon near the selected dictionary name. 
2. Type the desired new name and press Enter or press Tab to select the Rename button and press Enter. The dictionary will be renamed.

To disconnect the dictionary:

• Press the Tab continuously to select the Disconnecticon near the selected dictionary name and press Enter or Space. The dictionary is disconnected, and notification message appears in the lower part of Settings dialog.

About

To see the information about the version of WProofreader you are currently using, navigate to the About area of the Settings dialog. To do so:

1. Open Settings dialog.
2. Press Tab and Enter to select Options first and then repeatedly press the Down arrow key until the About section is highlighted and then press Enter or Space.

WProofreader add-on for rich text editors is a 2-in-1 solution that combines spell & grammar check as you type and in-dialog modes and can be conveniently integrated in any HTML editable tag or modern rich text editor (RTE).

WProofreader is compliant with the Web Content Accessibility Guidelines (WCAG) and Section 508 and comes along with keyboard navigation. Users with limited abilities can proofread, switch between the modes, tweak settings and complete other tasks using keyboard shortcuts only.

This guide is for WProofreader users and developers integrating WProofreader into their clients’ infrastructure. Check the below keyboard commands to use WProofreader.

Prerequisites

Proofreading in the as you type mode 

WProofreader checks users’ texts in editable HTML tags and rich text editors for spelling, grammar, and punctuation errors while the user is typing. The orange badge in the bottom right corner of the text box displays the total number of grammar, spelling and punctuation issues found in the active element. If there are no issues, you can see the tick sign on the badge.

Accessing more features

Users can access more WProofreader features through the badge, in particular:

• switch to Proofread in-dialog mode, 
• tweak spelling ignore options,
• create and manage dictionaries, 
• set the language for proofreading.

Press Tab  to navigate to the badge. You’ll see a badge highlighted with a circle around it. Then press Enter  or Space  to open the badge and switch to Proofread in dialog mode, the Settings dialog, toggle Proofreader options.

Keyboard commands to access more WProofreader  options:

Check the video below to use keyboard navigation to access all the capabilities of the WProofreader user interface.

Proofread in dialog mode

To switch to Proofread in dialog mode from the as-you-type mode, press Tab  to highlight the badge. Then press Enter  or Space  to display the badge actions. Use the Left  / Right  arrow key to navigate to the Proofread in dialog icon and press Enter  or Space .

With the below commands, users can accept/ignore WProofreader suggestions, add words to dictionary.

Tweaking settings

To access WProofreader settings, press Tab  to highlight the badge. Then press Enter  or Space  to display the badge actions. Use the  Left / Right arrow key to navigate to the Settings icon and press Enter or Space to open the Settings dialog.

Also, you can access the Settings from the Proofread in dialog mode. Keep pressing Tab or Shift + Tab for backwards until you focus on the Settings icon. It will be highlighted. Then press Enter or Space  to confirm. 

Spelling ignore options 

Use Tab to navigate between Ignore options in the Settings dialog. Select the desired option and press Space to enable/disable it.  The changes are applied automatically.

Language

Take the steps below to select a language for proofreading.

• Use Tab to navigate to the Language section in the Settings dialog.
• Press Enter or Space to open the list of available languages.
• Use the Up / Down arrow key to select a desired language.
• Press Enter or Space to confirm the action.   
• Press Escape to exit the Settings dialog.

Check the video below to see how to access and work with settings.

Dictionary

In the Dictionaries settings, users can create new dictionaries, connect or delete existing ones, add or remove words from the dictionaries.

Create or connect dictionary

To create or connect a dictionary:

• Open the Settings dialog and navigate to Go to Dictionary by continuously pressing Tab.
• Press Enter or Space to open Dictionary settings.
• Press Tab  to navigate to the Enter a dictionary name field and type in a name for your dictionary.
• Select Create or Connect and confirm your action by pressing Enter  or Space. As a result of this action, you’ll either create a new dictionary or connect an existing one.

Add word

To add a new word to a user dictionary, use Tab and navigate to the Enter a new word field. Type a new word and press Tab to move to the Add button. Confirm the action by pressing Space. Once the word is added, you’ll see a confirmation message “Word added”.

Delete word

To delete a word from the dictionary, use the Up / Down arrow key to move between words and choose a word you want to remove. Confirm the deletion by pressing Space or Enter. Once the word is deleted, you’ll see a confirmation message “Word deleted”.

Rename dictionary

To rename the dictionary, navigate to Dictionary settings using Tab and select Rename from the list. Confirm the action by pressing Space / Enter. Once the dictionary is renamed, you’ll see a confirmation message “Dictionary renamed”.

Disconnect dictionary

To disconnect the dictionary, navigate to Dictionary settings using Tab and select Disconnect from the list. Confirm the action by pressing Space or Enter.  Once the dictionary is disconnected, you’ll see a confirmation message “Dictionary disconnected”.

Check the video below to see how to manage dictionaries using keyboard navigation.

About

WProofreader version and copyright info is presented in the Settings dialog. You may find it useful when providing information about your system to our support team.