branch: elpa/mastodon
commit 9196718802e97f7faaf566acdfe7230266abd0de
Author: marty hiatt <[email protected]>
Commit: marty hiatt <[email protected]>
some readme updates
---
README.org | 60 ++++++++++++++++++++++++++++++++++++------------------------
1 file changed, 36 insertions(+), 24 deletions(-)
diff --git a/README.org b/README.org
index 498625f602..db79ddea12 100644
--- a/README.org
+++ b/README.org
@@ -127,6 +127,8 @@ not contain =:client_id= and =:client_secret=.
**** Keybindings
+For a full list of commands and variables, see
[[file:mastodon-index.org][mastodon-index.org]].
+
|----------------+---------------------------------------------------------------------------------|
| Key | Action
|
|----------------+---------------------------------------------------------------------------------|
@@ -156,6 +158,7 @@ not contain =:client_id= and =:client_secret=.
| =,= | view favouriters of toot at point
|
| =.= | view boosters of toot at point
|
| =/= | switch between mastodon buffers
|
+| =\= | prompt for an instance domain and view its local timeline
(if poss) |
| =Z= | report user/toot at point to instances moderators
|
|----------------+---------------------------------------------------------------------------------|
| | *Other views*
|
@@ -217,13 +220,15 @@ in =text-mode= and =mastodon-toot= minor mode. Enter the
contents of your toot
here. =C-c C-c= sends the toot. =C-c C-k= cancels. Both actions kill the buffer
and window. Further keybindings are displayed in the buffer, and in the
following subsection.
-Replies preserve visibility status/content warnings, and include boosters by
default.
+Replies preserve visibility status/content warnings, and include boosters by
default. If the region is active when you start a reply, it will be yanked into
the compose buffer prefixed with =>= to form a rough reply quote.
-Server's max toot length, and attachment previews, are shown.
+Server's max toot length, with running char count, and attachment previews,
are shown.
You can download and use your instance's custom emoji
(=mastodon-toot--download-custom-emoji=, =mastodon-toot--enable-custom-emoji=).
+If you want to view some of the toot being replied to in the compose buffer,
set =mastodon-toot-display-orig-in-reply-buffer= to non-nil.
+
The compose buffer uses =text-mode= so any configuration you have for that mode
will be enabled. If any of your existing config conflicts with =mastodon-toot=,
you can disable it in the =mastodon-toot-mode-hook=. For example, the default
@@ -237,28 +242,32 @@ value of that hook is as follows:
**** Keybindings
-|---------+----------------------------------|
-| Key | Action |
-|---------+----------------------------------|
-| =C-c C-c= | Send toot |
-| =C-c C-k= | Cancel toot |
-| =C-c C-w= | Add content warning |
-| =C-c C-v= | Change toot visibility |
-| =C-c C-n= | Add sensitive media/nsfw flag |
-| =C-c C-a= | Upload attachment(s) |
-| =C-c != | Remove all attachments |
-| =C-c C-e= | Add emoji (if =emojify= installed) |
-| =C-c C-p= | Create a poll |
-| =C-c C-l= | Set toot language |
-|---------+----------------------------------|
-
-**** Autocompletion of mentions, tags, and emoji
-
-Autocompletion of mentions, tags, and emoji is triggered by =@=, =#=, and =:=
-respectively, plus a few letters. It is provided by
+|----------+----------------------------------|
+| Key | Action |
+|----------+----------------------------------|
+| =C-c C-c= | Send toot |
+| =C-c C-k= | Cancel toot |
+| =C-c C-w= | Add content warning |
+| =C-c C-v= | Change toot visibility |
+| =C-c C-n= | Add sensitive media/nsfw flag |
+| =C-c C-a= | Upload attachment(s) |
+| =C-c != | Remove all attachments |
+| =C-c C-e= | Add emoji (if =emojify= installed) |
+| =C-c C-p= | Create a poll |
+| =C-c C-l= | Set toot language |
+| =-C-c C-s= | Schedule toot |
+|----------+----------------------------------|
+
+**** Autocompletion of mentions, tags and emoji
+
+Autocompletion of mentions, tags, and emojis is provided by
=completion-at-point-functions= (capf) backends.
-=mastodon-toot--enable-completion= is enabled by default. If you want to enable
-=company-mode= in the toot compose buffer, set
+=mastodon-toot--enable-completion= is enabled by default.
+
+To trigger completion, type a prefix followed by a few letters, =@= for
+mentions, =#= for tags, and =:= for emoji.
+
+If you want to enable =company-mode= in the toot compose buffer, set
=mastodon-toot--use-company-for-completion= to =t=. (=mastodon.el= used to run
its
own native company backends, but these have been removed in favour of capfs.)
@@ -277,7 +286,7 @@ combination is =consult= and =corfu=.
*** Other commands and account settings:
In addition to =mastodon=, the following three functions are autoloaded and
should
-work without first loading =mastodon.el=:
+work without first loading a =mastodon.el= buffer:
- =mastodon-toot=: Compose new toot
- =mastodon-notifications-get=: View all notifications
- =mastodon-url-lookup=: Attempt to load a URL in =mastodon.el=. URL may be at
@@ -352,6 +361,9 @@ See =M-x customize-group RET mastodon= to view all
customize options.
- Display toot being replied to
- Set default reply visibility
+- Nofitication options:
+ - Display user's profile note in follow requests
+
*** Commands and variables index
An index of all user-facing commands and custom variables is available here:
[[file:mastodon-index.org][mastodon-index.org]].
