summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2026-03-03 20:40:58 +0100
committerJonas Bernoulli <jonas@bernoul.li>2026-03-03 20:40:58 +0100
commit4dfc3e78161700884c3c0ad81d14f68308ef56fd (patch)
tree6679aaf4d036bf5e8ef4aaafc77be85e6850b484 /docs
parent935d5f1bb10438e16484bdefd295196e3f78bfba (diff)
transient-prefer-reading-value: New option
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org18
-rw-r--r--docs/transient.texi18
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/transient.org b/docs/transient.org
index 4f232e6..7fabeff 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -758,6 +758,24 @@ text at point, to be run when a transient menu is active, for example:
related commands are displayed in the same column but navigation
first moves horizontally to the next item on the same row.
+- User Option: transient-prefer-reading-value ::
+
+ This option controls whether reading a new value is preferred over
+ other value selection methods.
+
+ If this is ~nil~ (the default), then certain arguments are directly
+ disabled when they are invoked, while they have a non-~nil~ value. I.e.,
+ to switch from one non-~nil~ value to another non-~nil~ value, such commands
+ have to be invoked twice. For other arguments, which happen to have a
+ small set of possible values, all values are displayed at all times,
+ using solely coloring to indicate which of the values is active. When
+ such an infix command is invoked it cycles to the next value.
+
+ This default does not work for visually impaired user. If this option
+ is non-~nil~, then more arguments immediately read the new value, instead
+ of being toggled off on first invocation, or instead of cycling through
+ values.
+
*** Auxiliary Options
:PROPERTIES:
:UNNUMBERED: notoc
diff --git a/docs/transient.texi b/docs/transient.texi
index e2baf0f..faf2bb5 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -912,6 +912,24 @@ related commands are displayed in the same column but navigation
first moves horizontally to the next item on the same row.
@end defopt
+@defopt transient-prefer-reading-value
+This option controls whether reading a new value is preferred over
+other value selection methods.
+
+If this is @code{nil} (the default), then certain arguments are directly
+disabled when they are invoked, while they have a non-@code{nil} value. I.e.,
+to switch from one non-@code{nil} value to another non-@code{nil} value, such commands
+have to be invoked twice. For other arguments, which happen to have a
+small set of possible values, all values are displayed at all times,
+using solely coloring to indicate which of the values is active. When
+such an infix command is invoked it cycles to the next value.
+
+This default does not work for visually impaired user. If this option
+is non-@code{nil}, then more arguments immediately read the new value, instead
+of being toggled off on first invocation, or instead of cycling through
+values.
+@end defopt
+
@anchor{Auxiliary Options}
@subheading Auxiliary Options