@@ -31,7 +31,7 @@ General Public License for more details.
31
31
@finalout
32
32
@titlepage
33
33
@title Transient User and Developer Manual
34
- @subtitle for version 0.6 .0
34
+ @subtitle for version 0.7 .0
35
35
@author Jonas Bernoulli
36
36
@page
37
37
@vskip 0pt plus 1filll
@@ -53,7 +53,7 @@ resource to get over that hurdle is Psionic K's interactive tutorial,
53
53
available at @uref {https://github.com/positron-solutions/transient-showcase }.
54
54
55
55
@noindent
56
- This manual is for Transient version 0.6 .0.
56
+ This manual is for Transient version 0.7 .0.
57
57
58
58
@insertcopying
59
59
@end ifnottex
@@ -1112,7 +1112,8 @@ Transients}) and adds the transient's infix and suffix bindings, as
1112
1112
described below.
1113
1113
1114
1114
Users and third-party packages can add additional bindings using
1115
- functions such as @code {transient-insert-suffix } (@pxref {Modifying Existing Transients }). These functions take a ``suffix specification'' as one of
1115
+ functions such as @code {transient-insert-suffix } (@pxref {Modifying Existing Transients }).
1116
+ These functions take a ``suffix specification'' as one of
1116
1117
their arguments, which has the same form as the specifications used in
1117
1118
@code {transient-define-prefix }.
1118
1119
@@ -1380,16 +1381,12 @@ This macro defines @var{NAME} as a transient infix command.
1380
1381
reserved for future use. @var {DOCSTRING } is the documentation string and
1381
1382
is optional.
1382
1383
1383
- The keyword-value pairs are mandatory. All transient infix commands
1384
- are @code {equal } to each other (but not @code {eq }), so it is meaningless to define
1385
- an infix command without also setting at least @code {:class } and one other
1386
- keyword (which it is depends on the used class, usually @code {:argument } or
1387
- @code {:variable }).
1388
-
1389
- Each keyword has to be a keyword symbol, either @code {:class } or a keyword
1390
- argument supported by the constructor of that class. The
1391
- @code {transient-switch } class is used if the class is not specified
1392
- explicitly.
1384
+ At least one key-value pair is required. All transient infix
1385
+ commands are @code {equal } to each other (but not @code {eq }). It is meaningless
1386
+ to define an infix command, without providing at least one keyword
1387
+ argument (usually @code {:argument } or @code {:variable }, depending on the class).
1388
+ The suffix class defaults to @code {transient-switch } and can be set using
1389
+ the @code {:class } keyword.
1393
1390
1394
1391
The function definition is always:
1395
1392
@@ -2372,6 +2369,20 @@ the transient popup, you will be able to yank it in another buffer.
2372
2369
#'transient--do-stay )
2373
2370
@end lisp
2374
2371
2372
+ @anchor {How can I autoload prefix and suffix commands? }
2373
+ @appendixsec How can I autoload prefix and suffix commands?
2374
+
2375
+ If your package only supports Emacs 30, just prefix the definition
2376
+ with @code {;;;###autoload }. If your package supports released versions of
2377
+ Emacs, you unfortunately have to use a long form autoload comment
2378
+ as described in @ref {Autoload ,,,elisp ,}.
2379
+
2380
+ @lisp
2381
+ ;;;### autoload (autoload 'magit-dispatch "magit" nil t)
2382
+ (transient-define-prefix magit-dispatch ()
2383
+ ...)
2384
+ @end lisp
2385
+
2375
2386
@anchor {How does Transient compare to prefix keys and universal arguments? }
2376
2387
@appendixsec How does Transient compare to prefix keys and universal arguments?
2377
2388
0 commit comments