aboutsummaryrefslogtreecommitdiff
path: root/README.org
diff options
context:
space:
mode:
Diffstat (limited to 'README.org')
-rw-r--r--README.org107
1 files changed, 63 insertions, 44 deletions
diff --git a/README.org b/README.org
index 22b2531..f11ba61 100644
--- a/README.org
+++ b/README.org
@@ -6,48 +6,50 @@ This is a fork of of the great but seemingly dormant https://github.com/jdenen/m
It adds the following features:
-| Profiles: | |
-| | display profile metadata fields |
-| | display pinned toots first |
-| | display relationship (follows you/followed by you) |
-| | display toots/follows/followers counts |
-| | links/tags/mentions in profile bios are active links |
-| | show a lock icon for locked accounts |
-| =R=, =C-c a=, =C-c r= | view/accept/reject follow requests |
-| =V= | view your favorited toots |
-| =i= | toggle pinning of toots |
-| =S-C-P= | jump to your profile |
-| =U= | update your profile bio note |
-| =O= | jump to own profile |
-| Notifications: | |
-| | follow requests now also appear in notifications |
-| =a=, =r= | accept/reject follow request |
-| | notifications for when a user posts (=mastodon-tl--enable-notify-user-posts=) |
-| Timelines: | |
-| =C= | copy url of toot at point |
-| =d= | delete your toot at point, and reload current timeline |
-| =D= | delete and redraft toot at point, preserving reply/CW/visibility |
-| =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point |
-| =k=, =K= | toggle bookmark of toot at point, view bookmarked toots |
-| | display polls and vote on them |
-| | images are links to the full image, can be zoomed/rotated/saved (see image keymap) |
-| | images scale properly |
-| | toot visibility (direct, followers only) icon appears in toot bylines |
-| | display toot's number of favorites, boosts and replies |
-| | customize option to cache images |
-| Toots: | |
-| | mention booster in replies by default |
-| | replies preserve visibility status/CW of original toot |
-| | autocompletion of user mentions, via =company-mode= (must be installed to work) |
-| =C-c C-a= | media uploads, asynchronous |
-| | media upload previews displayed in toot compose buffer |
-| =C-c C-n= | and sensitive media/nsfw flag |
-| =C-c C-e= | add emoji (if =emojify= installed) |
-| | download and use your instance's custom emoji |
-| | server's maximum toot length shown in toot compose buffer |
-| Search: | |
-| =S= | search (posts, users, tags) (NB: only posts you have interacted with are searched) |
-| | |
+| Profiles: | |
+| | display profile metadata fields |
+| | display pinned toots first |
+| | display relationship (follows you/followed by you) |
+| | display toots/follows/followers counts |
+| | links/tags/mentions in profile bios are active links |
+| | show a lock icon for locked accounts |
+| =G= | view follow suggestions |
+| =R=, =a=, =r= | view/accept/reject follow requests |
+| =V= | view your favorited toots |
+| =i= | toggle pinning of toots |
+| =U= | update your profile bio note |
+| =O= | jump to own profile |
+| Notifications: | |
+| | follow requests now also appear in notifications |
+| =a=, =j= | accept/reject follow request |
+| | notifications for when a user posts (=mastodon-tl--enable-notify-user-posts=) |
+| Timelines: | |
+| =C= | copy url of toot at point |
+| =d= | delete your toot at point, and reload current timeline |
+| =D= | delete and redraft toot at point, preserving reply/CW/visibility |
+| =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point |
+| =k=, =K= | toggle bookmark of toot at point, view bookmarked toots |
+| =I=, =c=, =d= | view, create, and delete filters |
+| | display polls and vote on them |
+| | images are links to the full image, can be zoomed/rotated/saved (see image keymap) |
+| | images scale properly |
+| | toot visibility (direct, followers only) icon appears in toot bylines |
+| | display toot's number of favorites, boosts and replies |
+| | play gifs and videos (requires =mpv= to be installed) |
+| | customize option to cache images |
+| Toots: | |
+| | mention booster in replies by default |
+| | replies preserve visibility status/CW of original toot |
+| | autocompletion of user mentions, via =company-mode= (must be installed to work) |
+| =C-c C-a= | media uploads, asynchronous |
+| | media upload previews displayed in toot compose buffer |
+| =C-c C-n= | and sensitive media/nsfw flag |
+| =C-c C-e= | add emoji (if =emojify= installed) |
+| | download and use your instance's custom emoji |
+| | server's maximum toot length shown in toot compose buffer |
+| Search: | |
+| =S= | search (posts, users, tags) (NB: only posts you have interacted with are searched) |
+| | |
It also makes some small cosmetic changes to make timelines easier to read, and makes some functions asynchronous, based on https://github.com/ieure/mastodon.el.
@@ -65,9 +67,26 @@ Works for federated, local, and home timelines and for notifications. It's prett
To enable, it, add =(require 'mastodon-async)= to your =init.el=. Then you can view a timeline with one of the commands that begin with =mastodon-async--stream-=.
+** translating toots
+
+You can translate toots with =mastodon-toot--translate-toot-text=. At the moment this requires [[https://codeberg.org/martianh/lingva.el][lingva.el]], a little interface I wrote to https://lingva.ml, to be installed to work.
+
+You could easily modify the simple function to use your emacs translator of choice (=google-translate=, =babel=, =go-translate=, etc.), you just need to fetch the toot's content with =(mastodon-tl--content toot)= and pass it to your translator function as its text argument. Here's what =mastodon-toot--translate-toot-text= looks like:
+
+#+begin_src emacs-lisp
+ (defun mastodon-toot--translate-toot-text ()
+ "Translate text of toot at point.
+ Uses `lingva.el'."
+ (interactive)
+ (let* ((toot (mastodon-tl--property 'toot-json)))
+ (if toot
+ (lingva-translate nil (mastodon-tl--content toot))
+ (message "No toot to translate?"))))
+#+end_src
+
** NB: dependency
-This version depends on the library =request= (for uploading attachments). You can install it from MELPA, or https://github.com/tkf/emacs-request.
+This version depends on the library =request= (for uploading attachments). If you installed =mastodon.el= from MELPA, it should be fine, else you can install it yourself from MELPA or https://github.com/tkf/emacs-request.
** NB: bugs
@@ -77,7 +96,7 @@ This repo also incorporates fixes for two bugs that were never merged into the u
** contributing
-Contributions are welcome. Registration is disabled by default on the gitea instance, but if you are interested, get in touch with me on mastodon:
+Contributions are welcome. Feel free to open an issue or get in touch with me on mastodon:
[[https://todon.nl/@mousebot][@mousebot@todon.nl]]