aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-05-10 13:01:19 +0200
committermarty hiatt <martianhiatus [a t] riseup [d o t] net>2023-05-10 13:01:19 +0200
commite6a9d1228f238294e0f8ade48067a89b109b7572 (patch)
tree665cbfa7a46ce8cb4827f38f0c22346164226b5f
parent59a6bb22e51bfcb5d3840315848006272a8341ea (diff)
readme re completion
-rw-r--r--README.org37
-rw-r--r--mastodon.info67
-rw-r--r--mastodon.texi39
3 files changed, 89 insertions, 54 deletions
diff --git a/README.org b/README.org
index ffed894..7bc75db 100644
--- a/README.org
+++ b/README.org
@@ -196,13 +196,10 @@ not contain =:client_id= and =:client_secret=.
*** Composing toots
-=M-x mastodon-toot= (or =t= from a mastodon.el buffer).
-
-Pops a new buffer/window 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.
-
-Autocompletion of mentions and tags 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.)
+=M-x mastodon-toot= (or =t= from a mastodon.el buffer) opens a new buffer/window
+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.
@@ -239,6 +236,19 @@ value of that hook is as follows:
| =C-c C-l= | Set toot language |
|---------+----------------------------------|
+**** autocompletion of mentions and tags
+
+Autocompletion of mentions and tags 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.)
+
+If you don’t run =company= and want immediate, keyless completion, you’ll need
+to have another completion engine running that handles capfs. A common
+combination is =consult= and =corfu=.
+
**** Draft toots
- Compose buffer text is saved as you type, kept in =mastodon-toot-current-toot-text=.
@@ -327,7 +337,8 @@ See =M-x customize-group RET mastodon= to view all customize options.
*** Alternative timeline layout
-The incomparable Nicholas Rougier has written an alternative timeline layout for =mastodon.el=.
+The incomparable Nicholas Rougier has written an alternative timeline layout
+for =mastodon.el=.
The repo is at [[https://github.com/rougier/mastodon-alt][mastodon-alt]].
@@ -346,9 +357,9 @@ view a timeline with one of the commands that begin with
*** Translating toots
-You can translate toots with =mastodon-toot--translate-toot-text= (=a= in a timeline). At the moment
-this requires [[https://codeberg.org/martianh/lingva.el][lingva.el]], a little interface I wrote to [[https://lingva.ml][lingva.ml]], to
-be installed to work.
+You can translate toots with =mastodon-toot--translate-toot-text= (=a= in a
+timeline). At the moment this requires [[https://codeberg.org/martianh/lingva.el][lingva.el]], a little interface I wrote
+to [[https://lingva.ml][lingva.ml]], to be installed to work.
You could easily modify the simple function to use your Emacs translator of
choice (=libretrans.el= , =google-translate=, =babel=, =go-translate=, etc.), you just
@@ -368,7 +379,9 @@ to your translator function as its text argument. Here's what
#+end_src
*** bookmarks and =mastodon.el=
-=mastodon.el= doesn’t currently implement its own bookmark record and handler, which means that emacs bookmarks will not work as is. Until we implement them, you can get bookmarks going immediately by using [[https://github.com/emacsmirror/emacswiki.org/blob/master/bookmark%2b.el][bookmark+.el]].
+=mastodon.el= doesn’t currently implement its own bookmark record and handler,
+which means that emacs bookmarks will not work as is. Until we implement them,
+you can get bookmarks going immediately by using [[https://github.com/emacsmirror/emacswiki.org/blob/master/bookmark%2b.el][bookmark+.el]].
** Dependencies
diff --git a/mastodon.info b/mastodon.info
index d1389a1..12f5da4 100644
--- a/mastodon.info
+++ b/mastodon.info
@@ -292,19 +292,11 @@ File: mastodon.info, Node: Composing toots, Next: Other commands and account s
1.2.3 Composing toots
---------------------
-‘M-x mastodon-toot’ (or ‘t’ from a mastodon.el buffer).
-
- Pops a new buffer/window 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.
-
- Autocompletion of mentions and tags 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.)
+‘M-x mastodon-toot’ (or ‘t’ from a mastodon.el buffer) opens a new
+buffer/window 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.
@@ -340,7 +332,21 @@ is as follows:
‘C-c C-p’ Create a poll
‘C-c C-l’ Set toot language
- 2. Draft toots
+ 2. autocompletion of mentions and tags
+
+ Autocompletion of mentions and tags 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.)
+
+ If you don’t run ‘company’ and want immediate, keyless completion,
+ you’ll need to have another completion engine running that handles
+ capfs. A common combination is ‘consult’ and ‘corfu’.
+
+ 3. Draft toots
• Compose buffer text is saved as you type, kept in
‘mastodon-toot-current-toot-text’.
@@ -650,22 +656,23 @@ Node: Timelines4522
Ref: Keybindings4997
Ref: Toot byline legend9570
Node: Composing toots9879
-Ref: Keybindings (1)11456
-Ref: Draft toots11974
-Node: Other commands and account settings12445
-Node: Customization15603
-Node: Alternative timeline layout16389
-Node: Live-updating timelines mastodon-async-mode16779
-Node: Translating toots17631
-Node: bookmarks and mastodonel18813
-Node: Dependencies19283
-Node: Network compatibility19889
-Node: Contributing20375
-Node: Bug reports20664
-Node: Fixes and features21570
-Node: Coding style22053
-Node: Supporting mastodonel22677
-Node: Contributors23199
+Ref: Keybindings (1)11118
+Ref: autocompletion of mentions and tags11636
+Ref: Draft toots12349
+Node: Other commands and account settings12820
+Node: Customization15978
+Node: Alternative timeline layout16764
+Node: Live-updating timelines mastodon-async-mode17154
+Node: Translating toots18006
+Node: bookmarks and mastodonel19188
+Node: Dependencies19658
+Node: Network compatibility20264
+Node: Contributing20750
+Node: Bug reports21039
+Node: Fixes and features21945
+Node: Coding style22428
+Node: Supporting mastodonel23052
+Node: Contributors23574

End Tag Table
diff --git a/mastodon.texi b/mastodon.texi
index 122bbb1..1850844 100644
--- a/mastodon.texi
+++ b/mastodon.texi
@@ -362,13 +362,10 @@ not contain @samp{:client_id} and @samp{:client_secret}.
@node Composing toots
@subsection Composing toots
-@samp{M-x mastodon-toot} (or @samp{t} from a mastodon.el buffer).
-
-Pops a new buffer/window in @samp{text-mode} and @samp{mastodon-toot} minor mode. Enter the
-contents of your toot here. @samp{C-c C-c} sends the toot. @samp{C-c C-k} cancels.
-Both actions kill the buffer and window.
-
-Autocompletion of mentions and tags 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--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.)
+@samp{M-x mastodon-toot} (or @samp{t} from a mastodon.el buffer) opens a new buffer/window
+in @samp{text-mode} and @samp{mastodon-toot} minor mode. Enter the contents of your toot
+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.
@@ -419,6 +416,21 @@ value of that hook is as follows:
@end multitable
@item
+@anchor{autocompletion of mentions and tags}autocompletion of mentions and tags
+
+
+Autocompletion of mentions and tags 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--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.)
+
+If you don’t run @samp{company} and want immediate, keyless completion, you’ll need
+to have another completion engine running that handles capfs. A common
+combination is @samp{consult} and @samp{corfu}.
+
+@item
@anchor{Draft toots}Draft toots
@@ -584,7 +596,8 @@ Set default reply visibility
@node Alternative timeline layout
@subsection Alternative timeline layout
-The incomparable Nicholas Rougier has written an alternative timeline layout for @samp{mastodon.el}.
+The incomparable Nicholas Rougier has written an alternative timeline layout
+for @samp{mastodon.el}.
The repo is at @uref{https://github.com/rougier/mastodon-alt, mastodon-alt}.
@@ -605,9 +618,9 @@ view a timeline with one of the commands that begin with
@node Translating toots
@subsection Translating toots
-You can translate toots with @samp{mastodon-toot--translate-toot-text} (@samp{a} in a timeline). At the moment
-this requires @uref{https://codeberg.org/martianh/lingva.el, lingva.el}, a little interface I wrote to @uref{https://lingva.ml, lingva.ml}, to
-be installed to work.
+You can translate toots with @samp{mastodon-toot--translate-toot-text} (@samp{a} in a
+timeline). At the moment this requires @uref{https://codeberg.org/martianh/lingva.el, lingva.el}, a little interface I wrote
+to @uref{https://lingva.ml, lingva.ml}, to be installed to work.
You could easily modify the simple function to use your Emacs translator of
choice (@samp{libretrans.el} , @samp{google-translate}, @samp{babel}, @samp{go-translate}, etc.), you just
@@ -629,7 +642,9 @@ to your translator function as its text argument. Here's what
@node bookmarks and @samp{mastodonel}
@subsection bookmarks and @samp{mastodon.el}
-@samp{mastodon.el} doesn’t currently implement its own bookmark record and handler, which means that emacs bookmarks will not work as is. Until we implement them, you can get bookmarks going immediately by using @uref{https://github.com/emacsmirror/emacswiki.org/blob/master/bookmark%2b.el, bookmark+.el}.
+@samp{mastodon.el} doesn’t currently implement its own bookmark record and handler,
+which means that emacs bookmarks will not work as is. Until we implement them,
+you can get bookmarks going immediately by using @uref{https://github.com/emacsmirror/emacswiki.org/blob/master/bookmark%2b.el, bookmark+.el}.
@node Dependencies
@section Dependencies