diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2024-12-03 22:54:46 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2024-12-03 22:54:46 +0100 |
| commit | 8e1cf1ed164cadc19af0df24cdf0962e8ad32716 (patch) | |
| tree | d3a54616d5b69e1ef22d7d6dfd24894688751a9e | |
| parent | c9d46a40ee66932ca118e48bdda63f89d1de9ef9 (diff) | |
manual: Move two more options to "Essential Options"
| -rw-r--r-- | docs/transient.org | 84 | ||||
| -rw-r--r-- | docs/transient.texi | 84 |
2 files changed, 84 insertions, 84 deletions
diff --git a/docs/transient.org b/docs/transient.org index cde83c3..e2ad6f0 100644 --- a/docs/transient.org +++ b/docs/transient.org @@ -458,6 +458,48 @@ Also see [[* Common Suffix Commands]]. the popup is shown after that many seconds of inactivity (using the absolute value). +- User Option: transient-show-during-minibuffer-read :: + + This option controls whether the transient menu continues to be + displayed while the minibuffer is used to read user input. + + This is only relevant to commands that do not close the menu, such as + commands that set infix arguments. If a command exits the menu, and + uses the minibuffer, then the menu is always closed before the + minibuffer is entered, irrespective of the value of this option. + + When ~nil~ (the default), hide the menu while the minibuffer is in use. + When ~t~, keep showing the menu, but allow for the menu window to be + resized to ensure that completion candidates can be displayed. + + When ~fixed~, keep showing the menu and prevent it from being resized, + which may make it impossible to display the completion candidates. If + that ever happens for you, consider using ~t~ or an integer, as described + below. + + If the value is ~fixed~ and the menu window uses the full height of its + frame, then the former is ignored and resizing is allowed anyway. This + is necessary because individual menus may use unusual display actions + different from what ~transient-display-buffer-action~ specifies (likely + to display that menu in a side-window). + + When using a third-party mode, which automatically resizes windows + (e.g., by calling ~balance-windows~ on ~post-command-hook~), then + ~fixed~ (or ~nil~) is likely a better choice than ~t~. + + The value can also be an integer, in which case the behavior depends on + whether at least that many lines are left to display windows other than + the menu window. If that is the case, display the menu and preserve the + size of that window. Otherwise, allow resizing the menu window if the + number is positive, or hide the menu if it is negative. + +- User Option: transient-read-with-initial-input :: + + This option controls whether the last history element is used as the + initial minibuffer input when reading the value of an infix argument + from the user. If ~nil~, there is no initial input and the first + element has to be accessed the same way as the older elements. + - User Option: transient-enable-popup-navigation :: This option controls whether navigation commands are enabled in the @@ -622,48 +664,6 @@ Also see [[* Common Suffix Commands]]. key)))) #+END_SRC -- User Option: transient-read-with-initial-input :: - - This option controls whether the last history element is used as the - initial minibuffer input when reading the value of an infix argument - from the user. If ~nil~, there is no initial input and the first - element has to be accessed the same way as the older elements. - -- User Option: transient-show-during-minibuffer-read :: - - This option controls whether the transient menu continues to be - displayed while the minibuffer is used to read user input. - - This is only relevant to commands that do not close the menu, such as - commands that set infix arguments. If a command exits the menu, and - uses the minibuffer, then the menu is always closed before the - minibuffer is entered, irrespective of the value of this option. - - When ~nil~ (the default), hide the menu while the minibuffer is in use. - When ~t~, keep showing the menu, but allow for the menu window to be - resized to ensure that completion candidates can be displayed. - - When ~fixed~, keep showing the menu and prevent it from being resized, - which may make it impossible to display the completion candidates. If - that ever happens for you, consider using ~t~ or an integer, as described - below. - - If the value is ~fixed~ and the menu window uses the full height of its - frame, then the former is ignored and resizing is allowed anyway. This - is necessary because individual menus may use unusual display actions - different from what ~transient-display-buffer-action~ specifies (likely - to display that menu in a side-window). - - When using a third-party mode, which automatically resizes windows - (e.g., by calling ~balance-windows~ on ~post-command-hook~), then - ~fixed~ (or ~nil~) is likely a better choice than ~t~. - - The value can also be an integer, in which case the behavior depends on - whether at least that many lines are left to display windows other than - the menu window. If that is the case, display the menu and preserve the - size of that window. Otherwise, allow resizing the menu window if the - number is positive, or hide the menu if it is negative. - - User Option: transient-align-variable-pitch :: This option controls whether columns are aligned pixel-wise in the diff --git a/docs/transient.texi b/docs/transient.texi index 16a59fa..5e61d13 100644 --- a/docs/transient.texi +++ b/docs/transient.texi @@ -616,6 +616,48 @@ the absolute value). @end itemize @end defopt +@defopt transient-show-during-minibuffer-read +This option controls whether the transient menu continues to be +displayed while the minibuffer is used to read user input. + +This is only relevant to commands that do not close the menu, such as +commands that set infix arguments. If a command exits the menu, and +uses the minibuffer, then the menu is always closed before the +minibuffer is entered, irrespective of the value of this option. + +When @code{nil} (the default), hide the menu while the minibuffer is in use. +When @code{t}, keep showing the menu, but allow for the menu window to be +resized to ensure that completion candidates can be displayed. + +When @code{fixed}, keep showing the menu and prevent it from being resized, +which may make it impossible to display the completion candidates. If +that ever happens for you, consider using @code{t} or an integer, as described +below. + +If the value is @code{fixed} and the menu window uses the full height of its +frame, then the former is ignored and resizing is allowed anyway. This +is necessary because individual menus may use unusual display actions +different from what @code{transient-display-buffer-action} specifies (likely +to display that menu in a side-window). + +When using a third-party mode, which automatically resizes windows +(e.g., by calling @code{balance-windows} on @code{post-command-hook}), then +@code{fixed} (or @code{nil}) is likely a better choice than @code{t}. + +The value can also be an integer, in which case the behavior depends on +whether at least that many lines are left to display windows other than +the menu window. If that is the case, display the menu and preserve the +size of that window. Otherwise, allow resizing the menu window if the +number is positive, or hide the menu if it is negative. +@end defopt + +@defopt transient-read-with-initial-input +This option controls whether the last history element is used as the +initial minibuffer input when reading the value of an infix argument +from the user. If @code{nil}, there is no initial input and the first +element has to be accessed the same way as the older elements. +@end defopt + @defopt transient-enable-popup-navigation This option controls whether navigation commands are enabled in the transient popup buffer. If the value is @code{verbose}, additionally show @@ -781,48 +823,6 @@ optimized for lisp. @end lisp @end defopt -@defopt transient-read-with-initial-input -This option controls whether the last history element is used as the -initial minibuffer input when reading the value of an infix argument -from the user. If @code{nil}, there is no initial input and the first -element has to be accessed the same way as the older elements. -@end defopt - -@defopt transient-show-during-minibuffer-read -This option controls whether the transient menu continues to be -displayed while the minibuffer is used to read user input. - -This is only relevant to commands that do not close the menu, such as -commands that set infix arguments. If a command exits the menu, and -uses the minibuffer, then the menu is always closed before the -minibuffer is entered, irrespective of the value of this option. - -When @code{nil} (the default), hide the menu while the minibuffer is in use. -When @code{t}, keep showing the menu, but allow for the menu window to be -resized to ensure that completion candidates can be displayed. - -When @code{fixed}, keep showing the menu and prevent it from being resized, -which may make it impossible to display the completion candidates. If -that ever happens for you, consider using @code{t} or an integer, as described -below. - -If the value is @code{fixed} and the menu window uses the full height of its -frame, then the former is ignored and resizing is allowed anyway. This -is necessary because individual menus may use unusual display actions -different from what @code{transient-display-buffer-action} specifies (likely -to display that menu in a side-window). - -When using a third-party mode, which automatically resizes windows -(e.g., by calling @code{balance-windows} on @code{post-command-hook}), then -@code{fixed} (or @code{nil}) is likely a better choice than @code{t}. - -The value can also be an integer, in which case the behavior depends on -whether at least that many lines are left to display windows other than -the menu window. If that is the case, display the menu and preserve the -size of that window. Otherwise, allow resizing the menu window if the -number is positive, or hide the menu if it is negative. -@end defopt - @defopt transient-align-variable-pitch This option controls whether columns are aligned pixel-wise in the popup buffer. |
