From e6a9d1228f238294e0f8ade48067a89b109b7572 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 From 333109f2a312933e053dd4f6364093e30e2ba682 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Sat, 20 May 2023 10:50:45 +0200 Subject: readme re index --- README.org | 5 ++++ mastodon.info | 82 ++++++++++++++++++++++++++++++++++------------------------- mastodon.texi | 7 +++++ 3 files changed, 59 insertions(+), 35 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index 7bc75db..f5e0237 100644 --- a/README.org +++ b/README.org @@ -335,6 +335,10 @@ See =M-x customize-group RET mastodon= to view all customize options. - Display toot being replied to - Set default reply visibility +*** Commands and variables index + +An index of all user-facing commands and custom variables is available here: [[file:mastodon-index.org][mastodon-index.org]]. + *** Alternative timeline layout The incomparable Nicholas Rougier has written an alternative timeline layout @@ -379,6 +383,7 @@ 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]]. diff --git a/mastodon.info b/mastodon.info index 12f5da4..6ab20b4 100644 --- a/mastodon.info +++ b/mastodon.info @@ -38,6 +38,7 @@ Usage * Composing toots:: * Other commands and account settings:: * Customization:: +* commands and variables index:: * Alternative timeline layout:: * Live-updating timelines mastodon-async-mode:: * Translating toots:: @@ -161,6 +162,7 @@ File: mastodon.info, Node: Usage, Next: Dependencies, Prev: Installation, Up * Composing toots:: * Other commands and account settings:: * Customization:: +* commands and variables index:: * Alternative timeline layout:: * Live-updating timelines mastodon-async-mode:: * Translating toots:: @@ -424,7 +426,7 @@ and should work without first loading ‘mastodon.el’: posts are marked as sensitive (nsfw) by default.  -File: mastodon.info, Node: Customization, Next: Alternative timeline layout, Prev: Other commands and account settings, Up: Usage +File: mastodon.info, Node: Customization, Next: commands and variables index, Prev: Other commands and account settings, Up: Usage 1.2.5 Customization ------------------- @@ -449,9 +451,18 @@ See ‘M-x customize-group RET mastodon’ to view all customize options. • Set default reply visibility  -File: mastodon.info, Node: Alternative timeline layout, Next: Live-updating timelines mastodon-async-mode, Prev: Customization, Up: Usage +File: mastodon.info, Node: commands and variables index, Next: Alternative timeline layout, Prev: Customization, Up: Usage -1.2.6 Alternative timeline layout +1.2.6 commands and variables index +---------------------------------- + +An index of all user-facing commands and custom variables is available +here: mastodon-index.org (mastodon-index.org). + + +File: mastodon.info, Node: Alternative timeline layout, Next: Live-updating timelines mastodon-async-mode, Prev: commands and variables index, Up: Usage + +1.2.7 Alternative timeline layout --------------------------------- The incomparable Nicholas Rougier has written an alternative timeline @@ -463,7 +474,7 @@ layout for ‘mastodon.el’.  File: mastodon.info, Node: Live-updating timelines mastodon-async-mode, Next: Translating toots, Prev: Alternative timeline layout, Up: Usage -1.2.7 Live-updating timelines: ‘mastodon-async-mode’ +1.2.8 Live-updating timelines: ‘mastodon-async-mode’ ---------------------------------------------------- (code taken from mastodon-future @@ -482,7 +493,7 @@ Then you can view a timeline with one of the commands that begin with  File: mastodon.info, Node: Translating toots, Next: bookmarks and mastodonel, Prev: Live-updating timelines mastodon-async-mode, Up: Usage -1.2.8 Translating toots +1.2.9 Translating toots ----------------------- You can translate toots with ‘mastodon-toot--translate-toot-text’ (‘a’ @@ -509,8 +520,8 @@ looks like:  File: mastodon.info, Node: bookmarks and mastodonel, Prev: Translating toots, Up: Usage -1.2.9 bookmarks and ‘mastodon.el’ ---------------------------------- +1.2.10 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 @@ -645,34 +656,35 @@ File: mastodon.info, Node: Contributors, Prev: Supporting mastodonel, Up: REA  Tag Table: Node: Top210 -Node: README911 -Node: Installation1327 -Node: MELPA1863 -Node: Emoji2231 -Node: Discover2563 -Node: Usage3115 -Node: Logging in to your instance3525 -Node: Timelines4522 -Ref: Keybindings4997 -Ref: Toot byline legend9570 -Node: Composing toots9879 -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 +Node: README944 +Node: Installation1360 +Node: MELPA1896 +Node: Emoji2264 +Node: Discover2596 +Node: Usage3148 +Node: Logging in to your instance3591 +Node: Timelines4588 +Ref: Keybindings5063 +Ref: Toot byline legend9636 +Node: Composing toots9945 +Ref: Keybindings (1)11184 +Ref: autocompletion of mentions and tags11702 +Ref: Draft toots12415 +Node: Other commands and account settings12886 +Node: Customization16044 +Node: commands and variables index16831 +Node: Alternative timeline layout17151 +Node: Live-updating timelines mastodon-async-mode17556 +Node: Translating toots18408 +Node: bookmarks and mastodonel19590 +Node: Dependencies20062 +Node: Network compatibility20668 +Node: Contributing21154 +Node: Bug reports21443 +Node: Fixes and features22349 +Node: Coding style22832 +Node: Supporting mastodonel23456 +Node: Contributors23978  End Tag Table diff --git a/mastodon.texi b/mastodon.texi index 1850844..f1de236 100644 --- a/mastodon.texi +++ b/mastodon.texi @@ -52,6 +52,7 @@ Usage * Composing toots:: * Other commands and account settings:: * Customization:: +* commands and variables index:: * Alternative timeline layout:: * Live-updating timelines @samp{mastodon-async-mode}:: * Translating toots:: @@ -163,6 +164,7 @@ Or, with @samp{use-package}: * Composing toots:: * Other commands and account settings:: * Customization:: +* commands and variables index:: * Alternative timeline layout:: * Live-updating timelines @samp{mastodon-async-mode}:: * Translating toots:: @@ -593,6 +595,11 @@ Set default reply visibility @end itemize @end itemize +@node commands and variables index +@subsection commands and variables index + +An index of all user-facing commands and custom variables is available here: @uref{mastodon-index.org, mastodon-index.org}. + @node Alternative timeline layout @subsection Alternative timeline layout -- cgit v1.2.3 From 30b14bb52c852e1faa521e2d6e58d6aef01bdf71 Mon Sep 17 00:00:00 2001 From: marty hiatt Date: Mon, 26 Jun 2023 17:30:17 +0200 Subject: readme --- README.org | 4 ++-- mastodon.info | 4 ++-- mastodon.texi | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) (limited to 'README.org') diff --git a/README.org b/README.org index f5e0237..c16fd33 100644 --- a/README.org +++ b/README.org @@ -236,7 +236,7 @@ value of that hook is as follows: | =C-c C-l= | Set toot language | |---------+----------------------------------| -**** autocompletion of mentions and tags +**** Autocompletion of mentions and tags Autocompletion of mentions and tags is provided by =completion-at-point-functions= (capf) backends. @@ -382,7 +382,7 @@ to your translator function as its text argument. Here's what (message "No toot to translate?")))) #+end_src -*** bookmarks and =mastodon.el= +*** 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, diff --git a/mastodon.info b/mastodon.info index 7801b69..caae4d9 100644 --- a/mastodon.info +++ b/mastodon.info @@ -334,7 +334,7 @@ is as follows: ‘C-c C-p’ Create a poll ‘C-c C-l’ Set toot language - 2. autocompletion of mentions and tags + 2. Autocompletion of mentions and tags Autocompletion of mentions and tags is provided by ‘completion-at-point-functions’ (capf) backends. @@ -668,7 +668,7 @@ Ref: Keybindings5063 Ref: Toot byline legend9636 Node: Composing toots9945 Ref: Keybindings (1)11184 -Ref: autocompletion of mentions and tags11702 +Ref: Autocompletion of mentions and tags11702 Ref: Draft toots12415 Node: Other commands and account settings12886 Node: Customization16044 diff --git a/mastodon.texi b/mastodon.texi index c962985..1f2cd14 100644 --- a/mastodon.texi +++ b/mastodon.texi @@ -418,7 +418,7 @@ value of that hook is as follows: @end multitable @item -@anchor{autocompletion of mentions and tags}autocompletion of mentions and tags +@anchor{Autocompletion of mentions and tags}Autocompletion of mentions and tags Autocompletion of mentions and tags is provided by -- cgit v1.2.3