branch: externals/transient
commit 16e47e5773540bfc2493a8bee91ac77a0f89e931
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Reduce usage of the term "popup"
---
docs/transient.org | 96 ++++++++++++++++++++++++-------------------------
docs/transient.texi | 100 ++++++++++++++++++++++++++--------------------------
lisp/transient.el | 60 +++++++++++++++----------------
3 files changed, 128 insertions(+), 128 deletions(-)
diff --git a/docs/transient.org b/docs/transient.org
index 243a45ddc7..32c800fc3e 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -108,13 +108,14 @@ A transient prefix command is invoked like any other
command by
pressing the key that is bound to that command. The main difference
to other commands is that a transient prefix command activates a
transient keymap, which temporarily binds the transient's infix and
-suffix commands, and that those bindings are displayed in a transient
-menu, displayed in a popup buffer. Bindings from other keymaps may,
-or may not, be disabled while the transient state is in effect.
+suffix commands, and that those bindings are shown in menu buffer,
+which is displayed in a new window, until the menu is exited.
+Bindings from other keymaps may, or may not, be disabled while the
+transient state is in effect.
There are two kinds of commands that are available after invoking a
transient prefix command; infix and suffix commands. Infix commands
-set some value (which is then shown in the popup buffer), without
+set some value (which is then shown in the menu buffer), without
leaving the transient. Suffix commands, on the other hand, usually
quit the transient and they may use the values set by the infix
commands, i.e., the infix *arguments*.
@@ -139,7 +140,7 @@ prefix key, but not the complete transient).
A transient prefix command can be bound as a suffix of another
transient. Invoking such a suffix replaces the current transient
state with a new transient state, i.e., the available bindings change
-and the information displayed in the popup buffer is updated
+and the information displayed in the menu buffer is updated
accordingly. Pressing {{{kbd(C-g)}}} while a nested transient is active only
quits the innermost transient, causing a return to the previous
transient.
@@ -495,13 +496,13 @@ window, and the key bindings are the same as for
~scroll-up-command~ and
- Command: transient-scroll-up arg ::
- This command scrolls text of transient popup window upward {{{var(ARG)}}}
+ This command scrolls text of transient's menu window upward {{{var(ARG)}}}
lines. If {{{var(ARG)}}} is ~nil~, then it scrolls near full screen. This
is a wrapper around ~scroll-up-command~ (which see).
- Command: transient-scroll-down arg ::
- This command scrolls text of transient popup window down {{{var(ARG)}}}
+ This command scrolls text of transient's menu window down {{{var(ARG)}}}
lines. If {{{var(ARG)}}} is ~nil~, then it scrolls near full screen. This
is a wrapper around ~scroll-down-command~ (which see).
@@ -536,24 +537,23 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-show-popup ::
- This option controls whether the current transient's infix and
- suffix commands are shown in the popup buffer.
+ This option controls whether and when transient's menu buffer is
+ shown.
- - If ~t~ (the default) then the popup buffer is shown as soon as a
+ - If ~t~ (the default), then the buffer is shown as soon as a
transient prefix command is invoked.
- - If ~nil~, then the popup buffer is not shown unless the user
- explicitly requests it, by pressing an incomplete prefix key
- sequence.
+ - If ~nil~, then the buffer is not shown unless the user explicitly
+ requests it, by pressing an incomplete prefix key sequence.
- If a number, then the a brief one-line summary is shown instead of
- the popup buffer. If zero or negative, then not even that summary
+ the menu buffer. If zero or negative, then not even that summary
is shown; only the pressed key itself is shown.
- The popup is shown when the user explicitly requests it by
+ The buffer is shown once the user explicitly requests it by
pressing an incomplete prefix key sequence. Unless this is zero,
- the popup is shown after that many seconds of inactivity (using
- the absolute value).
+ the menu is shown after that many seconds of inactivity (using the
+ absolute value).
- User Option: transient-show-during-minibuffer-read ::
@@ -599,21 +599,21 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-enable-popup-navigation ::
- This option controls whether navigation commands are enabled in the
- transient popup buffer. If the value is ~verbose~ (the default),
+ This option controls whether navigation commands are enabled in
+ transient's menu buffer. If the value is ~verbose~ (the default),
brief documentation about the command under point is additionally
show in the echo area.
- While a transient is active the transient popup buffer is not the
- current buffer, making it necessary to use dedicated commands to act
- on that buffer itself. If this option is non-~nil~, then the
- following features are available:
+ While a transient is active the menu buffer is not the current
+ buffer, making it necessary to use dedicated commands to act on that
+ buffer itself. If this option is non-~nil~, then the following
+ features are available:
- {{{kbd(UP)}}} moves the cursor to the previous suffix.
- {{{kbd(DOWN)}}} moves the cursor to the next suffix.
- {{{kbd(M-RET)}}} invokes the suffix the cursor is on.
- {{{kbd(mouse-1)}}} invokes the clicked on suffix.
- - {{{kbd(C-s)}}} and {{{kbd(C-r)}}} start isearch in the popup buffer.
+ - {{{kbd(C-s)}}} and {{{kbd(C-r)}}} start isearch in the menu buffer.
By default {{{kbd(M-RET)}}} is bound to ~transient-push-button~, instead of
{{{kbd(RET)}}}, because if a transient allows the invocation of non-suffixes,
@@ -622,8 +622,8 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-display-buffer-action ::
- This option specifies the action used to display the transient popup
- buffer. The transient popup buffer is displayed in a window using
+ This option specifies the action used to display the transient's
+ menu buffer. The menu buffer is displayed in a window using
{{{codevar((display-buffer BUFFER transient-display-buffer-action))}}}.
The value of this option has the form {{{codevar((FUNCTION . ALIST))}}},
@@ -687,7 +687,7 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-mode-line-format ::
- This option controls whether the transient popup buffer has a
+ This option controls whether transient's menu buffer has a
mode-line, separator line, or neither.
If ~nil~, then the buffer has no mode-line. If the buffer is not
@@ -768,7 +768,7 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-align-variable-pitch ::
This option controls whether columns are aligned pixel-wise in the
- popup buffer.
+ menu buffer.
If this is non-~nil~, then columns are aligned pixel-wise to support
variable-pitch fonts. Keys are not aligned, so you should use a
@@ -782,10 +782,10 @@ Two more essential options are documented in [[* Common
Suffix Commands]].
- User Option: transient-force-fixed-pitch ::
This option controls whether to force the use of a monospaced font
- in popup buffer. Even if you use a proportional font for the
- ~default~ face, you might still want to use a monospaced font in
- transient's popup buffer. Setting this option to ~t~ causes ~default~
- to be remapped to ~fixed-pitch~ in that buffer.
+ in menu buffer. Even if you use a proportional font for the ~default~
+ face, you might still want to use a monospaced font in the menu
+ buffer. Setting this option to ~t~ causes ~default~ to be remapped to
+ ~fixed-pitch~ in that buffer.
*** Developer Options
:PROPERTIES:
@@ -951,7 +951,7 @@ When the user calls a transient prefix command, a transient
(temporary) keymap is activated, which binds the transient's infix and
suffix commands, and functions that control the transient state are
added to ~pre-command-hook~ and ~post-command-hook~. The available suffix
-and infix commands and their state are shown in a popup buffer until
+and infix commands and their state are shown in a menu buffer until
the transient state is exited by invoking a suffix command.
Calling an infix command causes its value to be changed. How that is
@@ -962,7 +962,7 @@ toggled on or off. More complex infix commands may read a
value from
the user, using the minibuffer.
Calling a suffix command usually causes the transient to be exited;
-the transient keymaps and hook functions are removed, the popup buffer
+the transient keymaps and hook functions are removed, the menu buffer
no longer shows information about the (no longer bound) suffix
commands, the values of some public global variables are set, while
some internal global variables are unset, and finally the command is
@@ -980,11 +980,11 @@ arguments have been set using a command such as
~universal-argument~.
#+cindex: command dispatchers
Transient can be used to implement simple “command dispatchers”. The
main benefit then is that the user can see all the available commands
-in a popup buffer, which can be thought of as a “menu”. That is
-useful by itself because it frees the user from having to remember all
-the keys that are valid after a certain prefix key or command.
-Magit's ~magit-dispatch~ (on {{{kbd(C-x M-g)}}}) command is an example of using
-Transient to merely implement a command dispatcher.
+in a temporarily shown buffer, which can be thought of as a “menu”.
+That is useful by itself because it frees the user from having to
+remember all the keys that are valid after a certain prefix key or
+command. Magit's ~magit-dispatch~ (on {{{kbd(C-x M-g)}}}) command is an
example of
+using Transient to merely implement a command dispatcher.
In addition to that, Transient also allows users to interactively pass
arguments to commands. These arguments can be much more complex than
@@ -1064,7 +1064,7 @@ that is used to invoke that transient.
explicitly.
{{{var(GROUP)}}}s add key bindings for infix and suffix commands and specify
- how these bindings are presented in the popup buffer. At least one
+ how these bindings are presented in the menu buffer. At least one
{{{var(GROUP)}}} has to be specified. See [[*Binding Suffix and Infix
Commands]].
The {{{var(BODY)}}} is optional. If it is omitted, then {{{var(ARGLIST)}}}
is ignored and
@@ -1331,7 +1331,7 @@ argument that is mandatory in all cases.
also be specified using ~:shortarg~) and the second as the long argument
(which can also be specified using ~:argument~).
- Only the long argument is displayed in the popup buffer. See
+ Only the long argument is displayed in the menu buffer. See
~transient-detect-key-conflicts~ for how the short argument may be
used.
@@ -1946,7 +1946,7 @@ beginning of the class specification, e.g., ~[:class
transient-columns
This generic function formats the group and its elements and inserts
the result into the current buffer, which is a temporary buffer.
- The contents of that buffer are later inserted into the popup buffer.
+ The contents of that buffer are later inserted into the menu buffer.
Functions that are called by this function may need to operate in
the buffer from which the transient was called. To do so they can
@@ -2416,7 +2416,7 @@ and ~advice*~ slots (see [[*Slots of
~transient-suffix~]]) are defined.
- ~transient~ Whether to stay transient. See [[*Transient State]].
-- ~format~ The format used to display the suffix in the popup buffer.
+- ~format~ The format used to display the suffix in the menu buffer.
It must contain the following %-placeholders:
- ~%k~ For the key.
@@ -2596,24 +2596,24 @@ See [[*Enabling and Disabling Suffixes]].
:APPENDIX: t
:END:
-** Can I control how the popup buffer is displayed?
+** Can I control how the menu buffer is displayed?
:PROPERTIES:
:UNNUMBERED: notoc
:END:
Yes, see ~transient-display-buffer-action~ in [[*Configuration]]. You can
-also control how the popup buffer is displayed on a case-by-case basis
+also control how the menu buffer is displayed on a case-by-case basis
by passing ~:display-action~ to ~transient-define-prefix~.
-** How can I copy text from the popup buffer?
+** How can I copy text from the menu buffer?
:PROPERTIES:
:UNNUMBERED: notoc
:END:
-To be able to mark text in Transient's popup buffer using the mouse,
+To be able to mark text in Transient's menu buffer using the mouse,
you have to add the below binding. Note that for technical reasons,
the region won't be visualized, while doing so. After you have quit
-the transient popup, you will be able to yank it in another buffer.
+the transient menu, you will be able to yank it in another buffer.
#+begin_src emacs-lisp
(keymap-set transient-predicate-map
diff --git a/docs/transient.texi b/docs/transient.texi
index a729599561..6f7089d5c0 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -216,13 +216,14 @@ A transient prefix command is invoked like any other
command by
pressing the key that is bound to that command. The main difference
to other commands is that a transient prefix command activates a
transient keymap, which temporarily binds the transient's infix and
-suffix commands, and that those bindings are displayed in a transient
-menu, displayed in a popup buffer. Bindings from other keymaps may,
-or may not, be disabled while the transient state is in effect.
+suffix commands, and that those bindings are shown in menu buffer,
+which is displayed in a new window, until the menu is exited.
+Bindings from other keymaps may, or may not, be disabled while the
+transient state is in effect.
There are two kinds of commands that are available after invoking a
transient prefix command; infix and suffix commands. Infix commands
-set some value (which is then shown in the popup buffer), without
+set some value (which is then shown in the menu buffer), without
leaving the transient. Suffix commands, on the other hand, usually
quit the transient and they may use the values set by the infix
commands, i.e., the infix @strong{arguments}.
@@ -249,7 +250,7 @@ prefix key, but not the complete transient).
A transient prefix command can be bound as a suffix of another
transient. Invoking such a suffix replaces the current transient
state with a new transient state, i.e., the available bindings change
-and the information displayed in the popup buffer is updated
+and the information displayed in the menu buffer is updated
accordingly. Pressing @kbd{C-g} while a nested transient is active only
quits the innermost transient, causing a return to the previous
transient.
@@ -641,13 +642,13 @@ window, and the key bindings are the same as for
@code{scroll-up-command} and
@code{scroll-down-command} in other buffers.
@deffn Command transient-scroll-up arg
-This command scrolls text of transient popup window upward @var{ARG}
+This command scrolls text of transient's menu window upward @var{ARG}
lines. If @var{ARG} is @code{nil}, then it scrolls near full screen. This
is a wrapper around @code{scroll-up-command} (which see).
@end deffn
@deffn Command transient-scroll-down arg
-This command scrolls text of transient popup window down @var{ARG}
+This command scrolls text of transient's menu window down @var{ARG}
lines. If @var{ARG} is @code{nil}, then it scrolls near full screen. This
is a wrapper around @code{scroll-down-command} (which see).
@end deffn
@@ -680,28 +681,27 @@ More options are described in @ref{Common Suffix
Commands}, in @ref{Saving Value
Two more essential options are documented in @ref{Common Suffix Commands}.
@defopt transient-show-popup
-This option controls whether the current transient's infix and
-suffix commands are shown in the popup buffer.
+This option controls whether and when transient's menu buffer is
+shown.
@itemize
@item
-If @code{t} (the default) then the popup buffer is shown as soon as a
+If @code{t} (the default), then the buffer is shown as soon as a
transient prefix command is invoked.
@item
-If @code{nil}, then the popup buffer is not shown unless the user
-explicitly requests it, by pressing an incomplete prefix key
-sequence.
+If @code{nil}, then the buffer is not shown unless the user explicitly
+requests it, by pressing an incomplete prefix key sequence.
@item
If a number, then the a brief one-line summary is shown instead of
-the popup buffer. If zero or negative, then not even that summary
+the menu buffer. If zero or negative, then not even that summary
is shown; only the pressed key itself is shown.
-The popup is shown when the user explicitly requests it by
+The buffer is shown once the user explicitly requests it by
pressing an incomplete prefix key sequence. Unless this is zero,
-the popup is shown after that many seconds of inactivity (using
-the absolute value).
+the menu is shown after that many seconds of inactivity (using the
+absolute value).
@end itemize
@end defopt
@@ -748,15 +748,15 @@ 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} (the default),
+This option controls whether navigation commands are enabled in
+transient's menu buffer. If the value is @code{verbose} (the default),
brief documentation about the command under point is additionally
show in the echo area.
-While a transient is active the transient popup buffer is not the
-current buffer, making it necessary to use dedicated commands to act
-on that buffer itself. If this option is non-@code{nil}, then the
-following features are available:
+While a transient is active the menu buffer is not the current
+buffer, making it necessary to use dedicated commands to act on that
+buffer itself. If this option is non-@code{nil}, then the following
+features are available:
@itemize
@item
@@ -768,7 +768,7 @@ following features are available:
@item
@kbd{mouse-1} invokes the clicked on suffix.
@item
-@kbd{C-s} and @kbd{C-r} start isearch in the popup buffer.
+@kbd{C-s} and @kbd{C-r} start isearch in the menu buffer.
@end itemize
By default @kbd{M-@key{RET}} is bound to @code{transient-push-button}, instead
of
@@ -778,8 +778,8 @@ if no transient were active."
@end defopt
@defopt transient-display-buffer-action
-This option specifies the action used to display the transient popup
-buffer. The transient popup buffer is displayed in a window using
+This option specifies the action used to display the transient's
+menu buffer. The menu buffer is displayed in a window using
@code{(display-buffer @var{BUFFER} transient-display-buffer-action)}.
The value of this option has the form @code{(@var{FUNCTION} . @var{ALIST})},
@@ -839,7 +839,7 @@ dimensions.
@subheading Auxiliary Options
@defopt transient-mode-line-format
-This option controls whether the transient popup buffer has a
+This option controls whether transient's menu buffer has a
mode-line, separator line, or neither.
If @code{nil}, then the buffer has no mode-line. If the buffer is not
@@ -919,7 +919,7 @@ optimized for lisp.
@defopt transient-align-variable-pitch
This option controls whether columns are aligned pixel-wise in the
-popup buffer.
+menu buffer.
If this is non-@code{nil}, then columns are aligned pixel-wise to support
variable-pitch fonts. Keys are not aligned, so you should use a
@@ -933,10 +933,10 @@ the @code{default} face.
@defopt transient-force-fixed-pitch
This option controls whether to force the use of a monospaced font
-in popup buffer. Even if you use a proportional font for the
-@code{default} face, you might still want to use a monospaced font in
-transient's popup buffer. Setting this option to @code{t} causes
@code{default}
-to be remapped to @code{fixed-pitch} in that buffer.
+in menu buffer. Even if you use a proportional font for the @code{default}
+face, you might still want to use a monospaced font in the menu
+buffer. Setting this option to @code{t} causes @code{default} to be remapped
to
+@code{fixed-pitch} in that buffer.
@end defopt
@anchor{Developer Options}
@@ -1122,7 +1122,7 @@ When the user calls a transient prefix command, a
transient
(temporary) keymap is activated, which binds the transient's infix and
suffix commands, and functions that control the transient state are
added to @code{pre-command-hook} and @code{post-command-hook}. The available
suffix
-and infix commands and their state are shown in a popup buffer until
+and infix commands and their state are shown in a menu buffer until
the transient state is exited by invoking a suffix command.
Calling an infix command causes its value to be changed. How that is
@@ -1133,7 +1133,7 @@ toggled on or off. More complex infix commands may read
a value from
the user, using the minibuffer.
Calling a suffix command usually causes the transient to be exited;
-the transient keymaps and hook functions are removed, the popup buffer
+the transient keymaps and hook functions are removed, the menu buffer
no longer shows information about the (no longer bound) suffix
commands, the values of some public global variables are set, while
some internal global variables are unset, and finally the command is
@@ -1151,11 +1151,11 @@ arguments have been set using a command such as
@code{universal-argument}.
@cindex command dispatchers
Transient can be used to implement simple ``command dispatchers''. The
main benefit then is that the user can see all the available commands
-in a popup buffer, which can be thought of as a ``menu''. That is
-useful by itself because it frees the user from having to remember all
-the keys that are valid after a certain prefix key or command.
-Magit's @code{magit-dispatch} (on @kbd{C-x M-g}) command is an example of using
-Transient to merely implement a command dispatcher.
+in a temporarily shown buffer, which can be thought of as a ``menu''.
+That is useful by itself because it frees the user from having to
+remember all the keys that are valid after a certain prefix key or
+command. Magit's @code{magit-dispatch} (on @kbd{C-x M-g}) command is an
example of
+using Transient to merely implement a command dispatcher.
In addition to that, Transient also allows users to interactively pass
arguments to commands. These arguments can be much more complex than
@@ -1235,7 +1235,7 @@ argument supported by the constructor of that class. The
explicitly.
@var{GROUP}s add key bindings for infix and suffix commands and specify
-how these bindings are presented in the popup buffer. At least one
+how these bindings are presented in the menu buffer. At least one
@var{GROUP} has to be specified. See @ref{Binding Suffix and Infix Commands}.
The @var{BODY} is optional. If it is omitted, then @var{ARGLIST} is ignored
and
@@ -1521,7 +1521,7 @@ which case the first string is used as the short argument
(which can
also be specified using @code{:shortarg}) and the second as the long argument
(which can also be specified using @code{:argument}).
-Only the long argument is displayed in the popup buffer. See
+Only the long argument is displayed in the menu buffer. See
@code{transient-detect-key-conflicts} for how the short argument may be
used.
@@ -2182,7 +2182,7 @@ children from scratch.
@defun transient--insert-group group
This generic function formats the group and its elements and inserts
the result into the current buffer, which is a temporary buffer.
-The contents of that buffer are later inserted into the popup buffer.
+The contents of that buffer are later inserted into the menu buffer.
Functions that are called by this function may need to operate in
the buffer from which the transient was called. To do so they can
@@ -2696,7 +2696,7 @@ and @code{advice*} slots (see @ref{Slots of
@code{transient-suffix}}) are define
@code{transient} Whether to stay transient. See @ref{Transient State}.
@item
-@code{format} The format used to display the suffix in the popup buffer.
+@code{format} The format used to display the suffix in the menu buffer.
It must contain the following %-placeholders:
@itemize
@@ -2929,20 +2929,20 @@ See @ref{Enabling and Disabling Suffixes}.
@node FAQ
@appendix FAQ
-@anchor{Can I control how the popup buffer is displayed?}
-@appendixsec Can I control how the popup buffer is displayed?
+@anchor{Can I control how the menu buffer is displayed?}
+@appendixsec Can I control how the menu buffer is displayed?
Yes, see @code{transient-display-buffer-action} in @ref{Configuration}. You
can
-also control how the popup buffer is displayed on a case-by-case basis
+also control how the menu buffer is displayed on a case-by-case basis
by passing @code{:display-action} to @code{transient-define-prefix}.
-@anchor{How can I copy text from the popup buffer?}
-@appendixsec How can I copy text from the popup buffer?
+@anchor{How can I copy text from the menu buffer?}
+@appendixsec How can I copy text from the menu buffer?
-To be able to mark text in Transient's popup buffer using the mouse,
+To be able to mark text in Transient's menu buffer using the mouse,
you have to add the below binding. Note that for technical reasons,
the region won't be visualized, while doing so. After you have quit
-the transient popup, you will be able to yank it in another buffer.
+the transient menu, you will be able to yank it in another buffer.
@lisp
(keymap-set transient-predicate-map
diff --git a/lisp/transient.el b/lisp/transient.el
index ad45e86f1f..7e3ba9a954 100644
--- a/lisp/transient.el
+++ b/lisp/transient.el
@@ -130,20 +130,20 @@ TYPE is a type descriptor as accepted by `cl-typep',
which see."
:group 'extensions)
(defcustom transient-show-popup t
- "Whether to show the current transient in a popup buffer.
+ "Whether and when to show transient's menu in a buffer.
\\<transient-map>
-- If t, then show the popup as soon as a transient prefix command
+- If t, then show the buffer as soon as a transient prefix command
is invoked.
-- If nil, then do not show the popup unless the user explicitly
+- If nil, then do not show the buffer unless the user explicitly
requests it, by pressing \\[transient-show] or a prefix key.
-- If a number, then delay displaying the popup and instead show
+- If a number, then delay displaying the buffer and instead show
a brief one-line summary. If zero or negative, then suppress
even showing that summary and display the pressed key only.
- Show the popup when the user explicitly requests it by pressing
- \\[transient-show] or a prefix key. Unless zero, then also show the popup
+ Show the buffer once the user explicitly requests it by pressing
+ \\[transient-show] or a prefix key. Unless zero, then also show the buffer
after that many seconds of inactivity (using the absolute value)."
:package-version '(transient . "0.1.0")
:group 'transient
@@ -153,12 +153,12 @@ TYPE is a type descriptor as accepted by `cl-typep',
which see."
(number :tag "After delay" 1)))
(defcustom transient-enable-popup-navigation 'verbose
- "Whether navigation commands are enabled in the transient popup.
+ "Whether navigation commands are enabled in the menu buffer.
If the value is `verbose', additionally show brief documentation
about the command under point in the echo area.
-While a transient is active the transient popup buffer is not the
+While a transient is active transient's menu buffer is not the
current buffer, making it necessary to use dedicated commands to
act on that buffer itself. If this is non-nil, then the following
bindings are available:
@@ -171,7 +171,7 @@ bindings are available:
- \\`<mouse-1>' and \\`<mouse-2>' invoke the clicked on suffix.
\\<transient-popup-navigation-map>\
- \\[transient-isearch-backward]\
- and \\[transient-isearch-forward] start isearch in the popup buffer.
+ and \\[transient-isearch-forward] start isearch in the menu buffer.
\\`<mouse-1>' and \\`<mouse-2>' are bound in `transient-push-button'.
All other bindings are in `transient-popup-navigation-map'.
@@ -191,9 +191,9 @@ if no transient were active."
(side . bottom)
(dedicated . t)
(inhibit-same-window . t))
- "The action used to display the transient popup buffer.
+ "The action used to display transient's menu buffer.
-The transient popup buffer is displayed in a window using
+The transient menu buffer is displayed in a window using
(display-buffer BUFFER transient-display-buffer-action)
@@ -253,7 +253,7 @@ is in characters."
:type 'natnum)
(defcustom transient-mode-line-format 'line
- "The mode-line format for the transient popup buffer.
+ "The mode-line format for transient's menu buffer.
If nil, then the buffer has no mode-line. If the buffer is not
displayed right above the echo area, then this probably is not
@@ -423,7 +423,7 @@ using a layout optimized for Lisp.
If non-nil, then the key binding of each suffix is colorized to
indicate whether it exits the transient state or not, and the
-line that is drawn below the transient popup buffer is used to
+line that is drawn below transient's menu buffer is used to
indicate the behavior of non-suffix commands."
:package-version '(transient . "0.5.0")
:group 'transient
@@ -450,7 +450,7 @@ a warning. If this is non-nil, they signal an error
instead."
:type 'boolean)
(defcustom transient-align-variable-pitch nil
- "Whether to align columns pixel-wise in the popup buffer.
+ "Whether to align columns pixel-wise in the menu buffer.
If this is non-nil, then columns are aligned pixel-wise to
support variable-pitch fonts. Keys are not aligned, so you
@@ -467,11 +467,11 @@ See also `transient-force-fixed-pitch'."
:type 'boolean)
(defcustom transient-force-fixed-pitch nil
- "Whether to force use of monospaced font in the popup buffer.
+ "Whether to force use of monospaced font in the menu buffer.
Even if you use a proportional font for the `default' face,
you might still want to use a monospaced font in transient's
-popup buffer. Setting this option to t causes `default' to
+menu buffer. Setting this option to t causes `default' to
be remapped to `fixed-pitch' in that buffer.
See also `transient-align-variable-pitch'."
@@ -1031,7 +1031,7 @@ argument supported by the constructor of that class. The
explicitly.
GROUPs add key bindings for infix and suffix commands and specify
-how these bindings are presented in the popup buffer. At least
+how these bindings are presented in the menu buffer. At least
one GROUP has to be specified. See info node `(transient)Binding
Suffix and Infix Commands'.
@@ -1714,7 +1714,7 @@ That buffer is current and empty when this hook runs.")
(defconst transient--exit nil "Do exit the transient.")
(defvar transient--exitp nil "Whether to exit the transient.")
-(defvar transient--showp nil "Whether to show the transient popup buffer.")
+(defvar transient--showp nil "Whether to show the transient menu buffer.")
(defvar transient--helpp nil "Whether help-mode is active.")
(defvar transient--docsp nil "Whether docstring-mode is active.")
(defvar transient--editp nil "Whether edit-mode is active.")
@@ -1738,7 +1738,7 @@ That buffer is current and empty when this hook runs.")
"The transient menu buffer.")
(defvar transient--window nil
- "The window used to display the transient popup buffer.")
+ "The window used to display transient's menu buffer.")
(defvar transient--original-window nil
"The window that was selected before the transient was invoked.
@@ -2042,7 +2042,7 @@ Common Suffix Commands'."
(transient--init-common-commands)))
(defvar-keymap transient-popup-navigation-map
- :doc "One of the keymaps used when popup navigation is enabled.
+ :doc "One of the keymaps used when menu navigation is enabled.
See `transient-enable-popup-navigation'."
"<down-mouse-1>" #'transient-noop
"<up>" #'transient-backward-button
@@ -2052,7 +2052,7 @@ See `transient-enable-popup-navigation'."
"M-RET" #'transient-push-button)
(defvar-keymap transient-button-map
- :doc "One of the keymaps used when popup navigation is enabled.
+ :doc "One of the keymaps used when menu navigation is enabled.
See `transient-enable-popup-navigation'."
"<mouse-1>" #'transient-push-button
"<mouse-2>" #'transient-push-button)
@@ -3223,7 +3223,7 @@ This should never happen.
Please open an issue and post the shown command log." :error)))
(defun transient-inhibit-move ()
- "Warn the user that popup navigation is disabled."
+ "Warn the user that menu navigation is disabled."
(interactive)
(message "To enable use of `%s', please customize `%s'"
this-original-command
@@ -3244,12 +3244,12 @@ Please open an issue and post the shown command log."
:error)))
(interactive))
(defun transient-update ()
- "Redraw the transient's state in the popup buffer."
+ "Redraw the transient's state in the menu buffer."
(interactive)
(setq prefix-arg current-prefix-arg))
(defun transient-show ()
- "Show the transient's state in the popup buffer."
+ "Show the transient's state in the menu buffer."
(interactive)
(setq transient--showp t))
@@ -4962,10 +4962,10 @@ This is used when a tooltip is needed.")
(let ((message-log-max nil))
(message "%s" doc))))))
-;;; Popup Navigation
+;;; Menu Navigation
(defun transient-scroll-up (&optional arg)
- "Scroll text of transient popup window upward ARG lines.
+ "Scroll text of transient's menu window upward ARG lines.
If ARG is nil scroll near full screen. This is a wrapper
around `scroll-up-command' (which see)."
(interactive "^P")
@@ -4973,7 +4973,7 @@ around `scroll-up-command' (which see)."
(scroll-up-command arg)))
(defun transient-scroll-down (&optional arg)
- "Scroll text of transient popup window down ARG lines.
+ "Scroll text of transient's menu window down ARG lines.
If ARG is nil scroll near full screen. This is a wrapper
around `scroll-down-command' (which see)."
(interactive "^P")
@@ -4981,7 +4981,7 @@ around `scroll-down-command' (which see)."
(scroll-down-command arg)))
(defun transient-backward-button (n)
- "Move to the previous button in the transient popup buffer.
+ "Move to the previous button in transient's menu buffer.
See `backward-button' for information about N."
(interactive "p")
(with-selected-window transient--window
@@ -4990,7 +4990,7 @@ See `backward-button' for information about N."
(transient-show-summary (get-text-property (point) 'suffix)))))
(defun transient-forward-button (n)
- "Move to the next button in the transient popup buffer.
+ "Move to the next button in transient's menu buffer.
See `forward-button' for information about N."
(interactive "p")
(with-selected-window transient--window
@@ -5030,7 +5030,7 @@ See `forward-button' for information about N."
beg 'face nil (line-end-position))))))
;;; Compatibility
-;;;; Popup Isearch
+;;;; Menu Isearch
(defvar-keymap transient--isearch-mode-map
:parent isearch-mode-map
