summaryrefslogtreecommitdiff
path: root/docs/transient.org
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2026-02-23 10:45:54 +0100
committerJonas Bernoulli <jonas@bernoul.li>2026-02-23 10:45:54 +0100
commitef2e69369d86acd904a2690db2f44f85e3eebd7e (patch)
treeec697ac57bc2cfc615efca38aa4b82ec7286f7ec /docs/transient.org
parentd2afeae40842d451342e3c6ed20daf319a1bba91 (diff)
manual: Improve Accessibility Options node
Diffstat (limited to 'docs/transient.org')
-rw-r--r--docs/transient.org30
1 files changed, 19 insertions, 11 deletions
diff --git a/docs/transient.org b/docs/transient.org
index 2ba2616..b8655c0 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -697,10 +697,16 @@ text at point, to be run when a transient menu is active, for example:
[my-read-text-at-point] #'transient--do-stay)
#+end_src
+- User Option: transient-enable-menu-navigation ::
+
+ This option is documented in the previous node ([[* Essential
+ Options]]).
+
- User Option: transient-navigate-to-group-descriptions ::
This option controls whether menu navigation commands stop at group
- descriptions.
+ descriptions. If your output method works by reading the text at
+ point, you most likely want to enable this.
If ~transient-enable-menu-navigation~ is non-~nil~, which it is by
default, {{{kbd(UP)}}} and {{{kbd(DOWN)}}} move from suffix to suffix. When this option
@@ -710,24 +716,24 @@ text at point, to be run when a transient menu is active, for example:
- User Option: transient-describe-menu ::
- This option controls whether short description is inserted at the
- beginning of the menu buffer.
+ This option controls whether a short description about the menu
+ itself is inserted at the beginning of the menu buffer.
When this is non-~nil~, then the menu buffer begins with a short
description. Ideally this is a string written exactly for that
- purpose, but because this is a new feature, most menu commands
- do not provide that yet. In that case the first line of its
- docstring is used as fallback. If the value is ~docstring~,
+ purpose, but because this is a new feature, most menu commands do
+ not provide that yet. In that case the first line of the prefix
+ command's docstring is used as fallback. If the value is ~docstring~,
then the docstring is used even if a description is available.
- User Option: transient-select-menu-window ::
This option controls whether the window displaying the transient menu
- is automatically selected has soon as it is displayed.
+ is automatically selected as soon as it is displayed.
- Enabling this is discouraged, except for users of braille output
- devises. Note that enabling this, or alternatively selecting the
- menu window on demand, are both unnecessary, to be able to move
+ Enabling this is discouraged, except for users of braille and audio
+ output devises. Note that enabling this, or alternatively selecting
+ the menu window on demand, are both unnecessary, to be able to move
the cursor in the menu. See ~transient-enable-menu-navigation~.
- User Option: transient-force-single-column ::
@@ -736,7 +742,9 @@ text at point, to be run when a transient menu is active, for example:
suffixes is enforced. This might be useful for users with low
vision who use large text and might otherwise have to scroll in two
dimensions. This is also useful for blind users, because it causes
- suffixes to be navigated in a more natural order.
+ suffixes to be navigated in a more natural order, because often
+ related commands are displayed in the same column but navigation
+ first moves horizonally to the next item on the same row.
*** Auxiliary Options
:PROPERTIES: