diff options
| author | Jonas Bernoulli | 2023-08-25 22:22:47 +0200 |
|---|---|---|
| committer | Jonas Bernoulli | 2023-08-27 14:47:14 +0200 |
| commit | 45cf3a0cede6662418bbab4897a2f04a9ef9c962 (patch) | |
| tree | cd15bd4ebe792173b7e42eac30549f95e547c9d3 /doc/misc | |
| parent | 31d3808fb9df98b75d8b199885cc9875f26a9215 (diff) | |
| download | emacs-45cf3a0cede6662418bbab4897a2f04a9ef9c962.tar.gz emacs-45cf3a0cede6662418bbab4897a2f04a9ef9c962.zip | |
Update to Transient v0.4.3
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/transient.texi | 66 |
1 files changed, 28 insertions, 38 deletions
diff --git a/doc/misc/transient.texi b/doc/misc/transient.texi index be9e8698ab4..e6144dcf2bc 100644 --- a/doc/misc/transient.texi +++ b/doc/misc/transient.texi | |||
| @@ -31,7 +31,7 @@ General Public License for more details. | |||
| 31 | @finalout | 31 | @finalout |
| 32 | @titlepage | 32 | @titlepage |
| 33 | @title Transient User and Developer Manual | 33 | @title Transient User and Developer Manual |
| 34 | @subtitle for version 0.4.1 | 34 | @subtitle for version 0.4.3 |
| 35 | @author Jonas Bernoulli | 35 | @author Jonas Bernoulli |
| 36 | @page | 36 | @page |
| 37 | @vskip 0pt plus 1filll | 37 | @vskip 0pt plus 1filll |
| @@ -74,7 +74,7 @@ that hurdle is Psionic K's interactive tutorial, available at | |||
| 74 | @end quotation | 74 | @end quotation |
| 75 | 75 | ||
| 76 | @noindent | 76 | @noindent |
| 77 | This manual is for Transient version 0.4.1. | 77 | This manual is for Transient version 0.4.3. |
| 78 | 78 | ||
| 79 | @insertcopying | 79 | @insertcopying |
| 80 | @end ifnottex | 80 | @end ifnottex |
| @@ -248,18 +248,18 @@ When using Transient, one can call a command with arguments that are | |||
| 248 | just as complex as when calling the same function non-interactively | 248 | just as complex as when calling the same function non-interactively |
| 249 | from Lisp. | 249 | from Lisp. |
| 250 | 250 | ||
| 251 | Invoking a transient command with arguments is similar to invoking a | 251 | Invoking a transient suffix command with arguments is similar to |
| 252 | command in a shell with command-line completion and history enabled. | 252 | invoking a command in a shell with command-line completion and history |
| 253 | One benefit of the Transient interface is that it remembers history | 253 | enabled. One benefit of the Transient interface is that it remembers |
| 254 | not only on a global level (“this command was invoked using these | 254 | history not only on a global level (“this command was invoked using |
| 255 | arguments, and previously it was invoked using those other arguments”), | 255 | these arguments, and previously it was invoked using those other |
| 256 | but also remembers the values of individual arguments independently. | 256 | arguments”), but also remembers the values of individual arguments |
| 257 | @xref{Using History}. | 257 | independently. See @xref{Using History}. |
| 258 | 258 | ||
| 259 | After a transient prefix command is invoked, @kbd{C-h @var{KEY}} can be used to | 259 | After a transient prefix command is invoked, @kbd{C-h @var{KEY}} can be used to |
| 260 | show the documentation for the infix or suffix command that @kbd{@var{KEY}} is | 260 | show the documentation for the infix or suffix command that @kbd{@var{KEY}} is |
| 261 | bound to (@pxref{Getting Help for Suffix Commands}), and infixes and | 261 | bound to (see @ref{Getting Help for Suffix Commands}), and infixes and |
| 262 | suffixes can be removed from the transient using @kbd{C-x l @var{KEY}}. Infixes | 262 | suffixes can be removed from the transient using @kbd{C-x l @var{KEY}}. Infixes |
| 263 | and suffixes that are disabled by default can be enabled the same way. | 263 | and suffixes that are disabled by default can be enabled the same way. |
| 264 | @xref{Enabling and Disabling Suffixes}. | 264 | @xref{Enabling and Disabling Suffixes}. |
| 265 | 265 | ||
| @@ -270,21 +270,26 @@ Additionally, Transient provides abstractions for defining new types, | |||
| 270 | which the author of Transient did not anticipate (or didn't get around | 270 | which the author of Transient did not anticipate (or didn't get around |
| 271 | to implementing yet). | 271 | to implementing yet). |
| 272 | 272 | ||
| 273 | Note that suffix commands also support regular prefix arguments. A | ||
| 274 | suffix command may even be called with both infix and prefix arguments | ||
| 275 | at the same time. If you invoke a command as a suffix of a transient | ||
| 276 | prefix command, but also want to pass prefix arguments to it, then | ||
| 277 | first invoke the prefix command, and only after doing that invoke the | ||
| 278 | prefix arguments, before finally invoking the suffix command. If you | ||
| 279 | instead began by providing the prefix arguments, then those would | ||
| 280 | apply to the prefix command, not the suffix command. Likewise, if you | ||
| 281 | want to change infix arguments before invoking a suffix command with | ||
| 282 | prefix arguments, then change the infix arguments before invoking the | ||
| 283 | prefix arguments. In other words, regular prefix arguments always | ||
| 284 | apply to the next command, and since transient prefix, infix and | ||
| 285 | suffix commands are just regular commands, the same applies to them. | ||
| 286 | (Regular prefix keys behave differently because they are not commands | ||
| 287 | at all, instead they are just incomplete key sequences, and those | ||
| 288 | cannot be interrupted with prefix commands.) | ||
| 289 | |||
| 273 | @node Usage | 290 | @node Usage |
| 274 | @chapter Usage | 291 | @chapter Usage |
| 275 | 292 | ||
| 276 | @menu | ||
| 277 | * Invoking Transients:: | ||
| 278 | * Aborting and Resuming Transients:: | ||
| 279 | * Common Suffix Commands:: | ||
| 280 | * Saving Values:: | ||
| 281 | * Using History:: | ||
| 282 | * Getting Help for Suffix Commands:: | ||
| 283 | * Enabling and Disabling Suffixes:: | ||
| 284 | * Other Commands:: | ||
| 285 | * Configuration:: | ||
| 286 | @end menu | ||
| 287 | |||
| 288 | @node Invoking Transients | 293 | @node Invoking Transients |
| 289 | @section Invoking Transients | 294 | @section Invoking Transients |
| 290 | 295 | ||
| @@ -997,14 +1002,6 @@ signal an error. | |||
| 997 | @node Defining New Commands | 1002 | @node Defining New Commands |
| 998 | @chapter Defining New Commands | 1003 | @chapter Defining New Commands |
| 999 | 1004 | ||
| 1000 | @menu | ||
| 1001 | * Defining Transients:: | ||
| 1002 | * Binding Suffix and Infix Commands:: | ||
| 1003 | * Defining Suffix and Infix Commands:: | ||
| 1004 | * Using Infix Arguments:: | ||
| 1005 | * Transient State:: | ||
| 1006 | @end menu | ||
| 1007 | |||
| 1008 | @node Defining Transients | 1005 | @node Defining Transients |
| 1009 | @section Defining Transients | 1006 | @section Defining Transients |
| 1010 | 1007 | ||
| @@ -2234,11 +2231,6 @@ available depending on user preference. | |||
| 2234 | @node Related Abstractions and Packages | 2231 | @node Related Abstractions and Packages |
| 2235 | @chapter Related Abstractions and Packages | 2232 | @chapter Related Abstractions and Packages |
| 2236 | 2233 | ||
| 2237 | @menu | ||
| 2238 | * Comparison With Prefix Keys and Prefix Arguments:: | ||
| 2239 | * Comparison With Other Packages:: | ||
| 2240 | @end menu | ||
| 2241 | |||
| 2242 | @node Comparison With Prefix Keys and Prefix Arguments | 2234 | @node Comparison With Prefix Keys and Prefix Arguments |
| 2243 | @section Comparison With Prefix Keys and Prefix Arguments | 2235 | @section Comparison With Prefix Keys and Prefix Arguments |
| 2244 | 2236 | ||
| @@ -2559,8 +2551,6 @@ currently exist. | |||
| 2559 | @node FAQ | 2551 | @node FAQ |
| 2560 | @appendix FAQ | 2552 | @appendix FAQ |
| 2561 | 2553 | ||
| 2562 | |||
| 2563 | |||
| 2564 | @anchor{Can I control how the popup buffer is displayed?} | 2554 | @anchor{Can I control how the popup buffer is displayed?} |
| 2565 | @appendixsec Can I control how the popup buffer is displayed? | 2555 | @appendixsec Can I control how the popup buffer is displayed? |
| 2566 | 2556 | ||