From a4745455998da50227b71c8c1f6603b3086106a4 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Wed, 10 May 2023 13:01:19 +0200 Subject: readme re completion --- README.org | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) (limited to 'README.org') 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 -- cgit v1.2.3