[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/transient d7b6412166 1/3: Convert readme to Org
From: |
Jonas Bernoulli |
Subject: |
[elpa] externals/transient d7b6412166 1/3: Convert readme to Org |
Date: |
Wed, 6 Apr 2022 17:14:39 -0400 (EDT) |
branch: externals/transient
commit d7b64121668208b7f2b23c7200754597e9e0d3aa
Author: Jonas Bernoulli <jonas@bernoul.li>
Commit: Jonas Bernoulli <jonas@bernoul.li>
Convert readme to Org
---
README.md => README.org | 31 ++++++++++++++++---------------
1 file changed, 16 insertions(+), 15 deletions(-)
diff --git a/README.md b/README.org
similarity index 69%
rename from README.md
rename to README.org
index 5de00584df..053fa92de9 100644
--- a/README.md
+++ b/README.org
@@ -1,5 +1,4 @@
-Transient commands
-==================
+* Transient commands
Taking inspiration from prefix keys and prefix arguments, Transient
implements a similar abstraction involving a prefix command, infix
@@ -8,19 +7,21 @@ arguments and suffix commands. We could call this
abstraction a
commands (a prefix and a suffix) we prefer to call it just a
"transient".
-> Transient keymaps are a feature provided by Emacs. Transients as
-> implemented by this package involve the use of transient keymaps.
->
-> Emacs provides a feature that it calls "prefix commands". When we
-> talk about "prefix commands" in Transient's documentation, then we
-> mean our own kind of "prefix commands", unless specified otherwise.
-> To avoid ambiguity we sometimes use the terms "transient prefix
-> command" for our kind and "regular prefix command" for Emacs' kind.
+#+begin_quote
+ Transient keymaps are a feature provided by Emacs. Transients as
+ implemented by this package involve the use of transient keymaps.
+
+ Emacs provides a feature that it calls "prefix commands". When we
+ talk about "prefix commands" in Transient's documentation, then we
+ mean our own kind of "prefix commands", unless specified otherwise.
+ To avoid ambiguity we sometimes use the terms "transient prefix
+ command" for our kind and "regular prefix command" for Emacs' kind.
+#+end_quote
When the user calls a transient prefix command, then 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
+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 the transient is exited by invoking a suffix command.
@@ -42,9 +43,9 @@ the transient.
A suffix command can, but does not have to, use the infix arguments in
much the same way it can choose to use or ignore the prefix arguments.
For a suffix command that was invoked from a transient the variable
-`transient-current-suffixes` and the function `transient-args` serve about
-the same purpose as the variables `prefix-arg` and `current-prefix-arg` do
+~transient-current-suffixes~ and the function ~transient-args~ serve about
+the same purpose as the variables ~prefix-arg~ and ~current-prefix-arg~ do
for any command that was called after the prefix arguments have been
-set using a command such as `universal-argument`.
+set using a command such as ~universal-argument~.
-![screenshot](http://readme.emacsair.me/transient.png)
+[[http://readme.emacsair.me/transient.png]]