branch: elpa/mastodon
commit 78d4d9a29dd95abf16e5cee6019e295b3e3642d6
Author: marty hiatt <[email protected]>
Commit: marty hiatt <[email protected]>
update info pages
---
mastodon.info | 134 +++++++++++++++++++++++++++++++++++-----------------------
mastodon.texi | 39 +++++++++++++----
2 files changed, 111 insertions(+), 62 deletions(-)
diff --git a/mastodon.info b/mastodon.info
index 16b19d0407..e300abeff7 100644
--- a/mastodon.info
+++ b/mastodon.info
@@ -63,6 +63,10 @@ File: mastodon.info, Node: README, Prev: Top, Up: Top
that implement the Mastodon API. For info see joinmastodon.org
(https://joinmastodon.org/).
+ NB: ‘mastodon.el’ now ships this readme as an .info file, so if you
+have it installed you should be able to browse this readme inside emacs.
+‘C-h i’ for info, then ‘m masto RET’ should load it for you.
+
* Menu:
* Installation::
@@ -237,6 +241,9 @@ your ‘mastodon-token-file’ does not contain ‘:client_id’ and
1. Keybindings
+ For a full list of commands and variables, see mastodon-index.org
+ (mastodon-index.org).
+
Key Action
-----------------------------------------------------------------------------------------------------------
*Help*
@@ -264,6 +271,7 @@ your ‘mastodon-token-file’ does not contain ‘:client_id’ and
‘,’ 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*
‘s’ search (posts, users, tags) (NB: only posts you
have interacted with)
@@ -326,14 +334,20 @@ 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.
+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
@@ -346,28 +360,33 @@ is as follows:
1. 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
-
- 2. Autocompletion of mentions and tags
-
- Autocompletion of mentions and tags 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
+
+ 2. 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--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.)
+ ‘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.)
If you don’t run ‘company’ and want immediate, keyless completion,
you’ll need to have another completion engine running that handles
@@ -390,7 +409,7 @@ File: mastodon.info, Node: Other commands and account
settings, Next: Customiz
------------------------------------------
In addition to ‘mastodon’, the following three functions are autoloaded
-and should work without first loading ‘mastodon.el’:
+and should 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
@@ -475,6 +494,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
+
File: mastodon.info, Node: Commands and variables index, Next: Alternative
timeline layout, Prev: Customization, Up: Usage
@@ -484,6 +506,10 @@ File: mastodon.info, Node: Commands and variables index,
Next: Alternative tim
An index of all user-facing commands and custom variables is available
here: mastodon-index.org (mastodon-index.org).
+ You can also hit ‘?’ in any ‘mastodon.el’ buffer to see the available
+bindings, or run ‘M-X’ (upper-case ‘X’) to view all commands in the
+buffer with completion, and call one.
+
File: mastodon.info, Node: Alternative timeline layout, Next: Live-updating
timelines mastodon-async-mode, Prev: Commands and variables index, Up: Usage
@@ -695,36 +721,36 @@ File: mastodon.info, Node: Contributors, Prev:
Supporting mastodonel, Up: REA
Tag Table:
Node: Top210
Node: README962
-Node: Installation1378
-Node: ELPA1667
-Node: MELPA1895
-Node: Repo2275
-Node: Emoji2768
-Node: Discover3099
-Node: Usage3651
-Node: Logging in to your instance4094
-Node: Timelines5091
-Ref: Keybindings5566
-Ref: Toot byline legend10139
-Node: Composing toots10448
-Ref: Keybindings (1)11687
-Ref: Autocompletion of mentions and tags12205
-Ref: Draft toots12918
-Node: Other commands and account settings13389
-Node: Customization16547
-Node: Commands and variables index17334
-Node: Alternative timeline layout17654
-Node: Live-updating timelines mastodon-async-mode18059
-Node: Translating toots18911
-Node: Bookmarks and mastodonel20093
-Node: Dependencies20565
-Node: Network compatibility21175
-Node: Contributing22057
-Node: Bug reports22553
-Node: Fixes and features23464
-Node: Coding style23965
-Node: Supporting mastodonel24589
-Node: Contributors25156
+Node: Installation1596
+Node: ELPA1885
+Node: MELPA2113
+Node: Repo2493
+Node: Emoji2986
+Node: Discover3317
+Node: Usage3869
+Node: Logging in to your instance4312
+Node: Timelines5309
+Ref: Keybindings5784
+Ref: Toot byline legend10558
+Node: Composing toots10867
+Ref: Keybindings (1)12419
+Ref: Autocompletion of mentions tags and emoji12985
+Ref: Draft toots13851
+Node: Other commands and account settings14322
+Node: Customization17489
+Node: Commands and variables index18367
+Node: Alternative timeline layout18883
+Node: Live-updating timelines mastodon-async-mode19288
+Node: Translating toots20140
+Node: Bookmarks and mastodonel21322
+Node: Dependencies21794
+Node: Network compatibility22404
+Node: Contributing23286
+Node: Bug reports23782
+Node: Fixes and features24693
+Node: Coding style25194
+Node: Supporting mastodonel25818
+Node: Contributors26385
End Tag Table
diff --git a/mastodon.texi b/mastodon.texi
index b33162da32..571a2d7dd0 100644
--- a/mastodon.texi
+++ b/mastodon.texi
@@ -75,6 +75,8 @@ Contributing
@samp{mastodon.el} is an Emacs client for the AcitivityPub social networks that
implement the Mastodon API@. For info see @uref{https://joinmastodon.org/,
joinmastodon.org}.
+NB: @samp{mastodon.el} now ships this readme as an .info file, so if you have
it installed you should be able to browse this readme inside emacs. @samp{C-h
i} for info, then @samp{m masto RET} should load it for you.
+
@menu
* Installation::
* Usage::
@@ -234,6 +236,8 @@ not contain @samp{:client_id} and @samp{:client_secret}.
@anchor{Keybindings}Keybindings
+For a full list of commands and variables, see @uref{mastodon-index.org,
mastodon-index.org}.
+
@multitable {aaaaaaaaaaaaaaaaaaaaaa}
{aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@headitem Key
@tab Action
@@ -287,6 +291,8 @@ not contain @samp{:client_id} and @samp{:client_secret}.
@tab view boosters of toot at point
@item @samp{/}
@tab switch between mastodon buffers
+@item @samp{\}
+@tab prompt for an instance domain and view its local timeline (if poss)
@item @samp{Z}
@tab report user/toot at point to instances moderators
@item
@@ -387,13 +393,15 @@ in @samp{text-mode} and @samp{mastodon-toot} minor mode.
Enter the contents of y
here. @samp{C-c C-c} sends the toot. @samp{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 @samp{>} 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
(@samp{mastodon-toot--download-custom-emoji},
@samp{mastodon-toot--enable-custom-emoji}).
+If you want to view some of the toot being replied to in the compose buffer,
set @samp{mastodon-toot-display-orig-in-reply-buffer} to non-nil.
+
The compose buffer uses @samp{text-mode} so any configuration you have for
that mode
will be enabled. If any of your existing config conflicts with
@samp{mastodon-toot},
you can disable it in the @samp{mastodon-toot-mode-hook}. For example, the
default
@@ -410,7 +418,7 @@ value of that hook is as follows:
@anchor{Keybindings (1)}Keybindings
-@multitable {aaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
+@multitable {aaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa}
@headitem Key
@tab Action
@item @samp{C-c C-c}
@@ -433,16 +441,22 @@ value of that hook is as follows:
@tab Create a poll
@item @samp{C-c C-l}
@tab Set toot language
+@item @samp{-C-c C-s}
+@tab Schedule toot
@end multitable
@item
-@anchor{Autocompletion of mentions and tags}Autocompletion of mentions and tags
+@anchor{Autocompletion of mentions tags and emoji}Autocompletion of mentions,
tags and emoji
-Autocompletion of mentions and tags is provided by
+Autocompletion of mentions, tags, and emojis is provided by
@samp{completion-at-point-functions} (capf) backends.
-@samp{mastodon-toot--enable-completion} is enabled by default. If you want to
enable
-@samp{company-mode} in the toot compose buffer, set
+@samp{mastodon-toot--enable-completion} is enabled by default.
+
+To trigger completion, type a prefix followed by a few letters, @samp{@@} for
+mentions, @samp{#} for tags, and @samp{:} for emoji.
+
+If you want to enable @samp{company-mode} in the toot compose buffer, set
@samp{mastodon-toot--use-company-for-completion} to @samp{t}.
(@samp{mastodon.el} used to run its
own native company backends, but these have been removed in favour of capfs.)
@@ -472,7 +486,7 @@ Compose buffer text is saved as you type, kept in
@samp{mastodon-toot-current-to
@subsection Other commands and account settings:
In addition to @samp{mastodon}, the following three functions are autoloaded
and should
-work without first loading @samp{mastodon.el}:
+work without first loading a @samp{mastodon.el} buffer:
@itemize
@item
@samp{mastodon-toot}: Compose new toot
@@ -611,6 +625,13 @@ Display toot being replied to
@item
Set default reply visibility
@end itemize
+
+@item
+Nofitication options:
+@itemize
+@item
+Display user's profile note in follow requests
+@end itemize
@end itemize
@node Commands and variables index
@@ -618,6 +639,8 @@ Set default reply visibility
An index of all user-facing commands and custom variables is available here:
@uref{mastodon-index.org, mastodon-index.org}.
+You can also hit @samp{?} in any @samp{mastodon.el} buffer to see the
available bindings, or run @samp{M-X} (upper-case @samp{X}) to view all
commands in the buffer with completion, and call one.
+
@node Alternative timeline layout
@subsection Alternative timeline layout
