Skip to content

Commit 413bc13

Browse files
committed
Docs: DOC-2621 - Accessibility page improvements
- Add How to use the editor section with keyboard navigation shortcuts - Document Ctrl+F9 for focusing contextual toolbar (e.g. editing image alt-text) - Explain menus vs toolbars and when to use each - Add screen reader guidance (VoiceOver, JAWS, NVDA) and Help plugin link - Add keywords metadata and intro paragraph - Fix help_accessibility heading format and HTML capitalization in examples
1 parent 7727a5b commit 413bc13

4 files changed

Lines changed: 50 additions & 4 deletions

File tree

modules/ROOT/pages/accessibility.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
:navtitle: Accessibility
33
:description_short: Configure the accessibility of TinyMCE.
44
:description: Configure the accessibility of TinyMCE.
5+
:keywords: accessibility, keyboard navigation, screen reader, a11y
6+
7+
This page describes configuration options that affect how {productname} supports keyboard users and screen readers. For guidance on using the editor with the keyboard, see the xref:accessibility.adoc#how-to-use-the-editor[How to use the editor] section that follows.
8+
9+
include::partial$configuration/accessibility-keyboard-navigation.adoc[]
510

611
include::partial$configuration/a11y_advanced_options.adoc[]
712

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
[[how-to-use-the-editor]]
2+
== How to use the editor
3+
4+
{productname} supports full keyboard navigation. Users can access the menu bar, toolbars, and contextual toolbars without using a mouse.
5+
6+
=== Menus and toolbars
7+
8+
The editor provides two main ways to access formatting and editing features:
9+
10+
* **Menu bar**: Use the menu bar when the desired command is known. Menus group related actions and can be faster to navigate for experienced users.
11+
* **Toolbars**: Use the main toolbar for frequently used actions. Toolbar buttons are visible by default and provide quick access to common formatting options.
12+
* **Contextual toolbars**: Some actions are available only from contextual toolbars that appear when the cursor is on specific content, such as images, links, or tables.
13+
14+
[TIP]
15+
====
16+
When a feature appears only in a contextual toolbar (for example, editing alternative text for an image), use the keyboard shortcut to focus the contextual toolbar. See the table below.
17+
====
18+
19+
=== Keyboard shortcuts for editor navigation
20+
21+
[cols="1,2,2",options="header"]
22+
|===
23+
|Action |Windows or Linux |macOS
24+
|Focus the menu bar |Alt+F9 |⌥+F9
25+
|Focus the toolbar |Alt+F10 |⌥+F10
26+
|Focus the element path (footer) |Alt+F11 |⌥+F11
27+
|Focus notifications |Alt+F12 |⌥+F12
28+
|Focus the contextual toolbar |Ctrl+F9 |Ctrl+F9
29+
|Open the Help dialog |Alt+0 |⌥+0
30+
|===
31+
32+
The contextual toolbar appears when the cursor is on content that has context-specific actions, such as an image or a link. For example, to edit alternative text for an image using only the keyboard:
33+
34+
. Place the cursor on the image.
35+
. Press Ctrl+F9 (Windows, Linux, or macOS) to focus the contextual toolbar.
36+
. Use the arrow keys to move to the desired button (for example, *Image options* or *Alternative description*).
37+
. Press Enter or Space to activate the button.
38+
39+
=== Screen readers
40+
41+
{productname} works with common screen readers, including VoiceOver (macOS and iOS), JAWS, and NVDA. The xref:help.adoc[Help] plugin provides a Keyboard Navigation tab that documents the full keyboard navigation model. When the Help plugin is loaded, the shortcut to open the Help dialog (Alt+0 or ⌥+0) appears in the status bar by default.

modules/ROOT/partials/configuration/help_accessibility.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[[help_accessibility]]
2-
== `help_accessibility`
2+
== `+help_accessibility+`
33

44
When the xref:help.adoc[Help] plugin is loaded, the {productname} editor displays the keyboard shortcut for accessing the Help dialog in the {productname} status bar by default.
55

@@ -16,7 +16,7 @@ The `help_accessibility` option allows for this display to be turned off.
1616
[source,js]
1717
----
1818
tinymce.init({
19-
selector: "textarea", // change this value according to your html
19+
selector: "textarea", // change this value according to your HTML
2020
plugins: "help",
2121
help_accessibility: false,
2222
});
@@ -31,7 +31,7 @@ It is not necessary, but may be useful, to explicitly set the option to `true`.
3131
[source,js]
3232
----
3333
tinymce.init({
34-
selector: "textarea", // change this value according to your html
34+
selector: "textarea", // change this value according to your HTML
3535
plugins: "help",
3636
help_accessibility: true,
3737
});

modules/ROOT/partials/configuration/iframe_aria_text.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The `+title+` attribute is read by screen-readers to help users identify the edi
1919
[source,js]
2020
----
2121
tinymce.init({
22-
selector: 'textarea', // change this value according to your html
22+
selector: 'textarea', // change this value according to your HTML
2323
iframe_aria_text: 'Text Editor'
2424
});
2525
----

0 commit comments

Comments
 (0)