# Keyboard navigation

WProofreader add-on for rich text editors is a all-in-1 solution that combines spell & grammar check in several proofreading modes and can be conveniently integrated in any HTML editable control or modern rich text editor (RTE).

WProofreader is compliant with the [Web Content Accessibility Guidelines (WCAG)](https://www.w3.org/TR/WCAG20/) and [Section 508](https://www.section508.gov/content/learn/laws-and-policies) 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 <a href="#draft-keyboardnavigationforv3.x.x-prerequisites" id="draft-keyboardnavigationforv3.x.x-prerequisites"></a>

| Version          | VERSION 3.0.0+ |
| ---------------- | -------------- |
| Theme            | Standard       |
| Rich text editor | CKEditor 4     |
| Language         | English        |

### Proofreading in the as-you-type mode <a href="#draft-keyboardnavigationforv3.x.x-proofreadingintheasyoutypemode" id="draft-keyboardnavigationforv3.x.x-proofreadingintheasyoutypemode"></a>

WProofreader checks users’ texts in editable HTML elements and rich text editors for spelling, grammar, and punctuation errors while the user is typing. The red 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 orange badge.

### Accessing more features <a href="#draft-keyboardnavigationforv3.x.x-accessingmorefeatures" id="draft-keyboardnavigationforv3.x.x-accessingmorefeatures"></a>

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 the proofread-in-dialog mode, the Settings dialog, toggle Proofreader options.

On MacOS laptops, only **`Space`** can be used to open the list of languages. However, this depends a lot on the system preferences.

Keyboard commands to access more WProofreader options:

| Keyboard command            | Description                                                                                                                         |
| --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `←` and `→` arrow key       | Move between items                                                                                                                  |
| `Enter` / `Space`           | <ul><li>Disable / enable WProofreader</li><li>Activate the Settings dialog</li><li>Switch to the proofread-in-dialog mode</li></ul> |
| <p><code>Esc</code><br></p> | Close WProofreader menu                                                                                                             |

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

### Proofread-in-dialog mode <a href="#draft-keyboardnavigationforv3.x.x-proofreadindialogmode" id="draft-keyboardnavigationforv3.x.x-proofreadindialogmode"></a>

To switch to the 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 commands below, users can accept/ignore WProofreader suggestions, and add words to a dictionary.

| Keyboard command           | Description                                                                                                                                                                          |
| -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Left` / `Right` arrow key | Move between grammar and spelling issues found. The selected issue is highlighted.                                                                                                   |
| `Up` / `Down` arrow key    | <p>Navigate inside the suggestion area:</p><ul><li>move between WProofreader suggestions;</li><li>select <strong>Add word</strong> or <strong>Ignore all</strong> actions.</li></ul> |
| `Enter` / `Space`          | Accept a suggestion, confirm action.                                                                                                                                                 |

### Tweaking settings <a href="#draft-keyboardnavigationforv3.x.x-tweakingsettings" id="draft-keyboardnavigationforv3.x.x-tweakingsettings"></a>

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`** 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.

| Keyboard command        | Description                                          |
| ----------------------- | ---------------------------------------------------- |
| `Tab` / `Shift` + `Tab` | Move between **Ignore options** forward or backward. |
| `Space`                 | Enable/disable the desired ignore option.            |

### **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 with 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* successfully 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 successfully* deleted."

**Rename dictionary**

To rename the dictionary, navigate to Dictionary settings using **`Tab`** and select **Rename** from the lis&#x74;**.** 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 are presented in the Settings dialog. You may find it useful when providing information about your system to our support team.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.wproofreader.com/user-manuals/keyboard-navigation.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
