diff options
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 161 |
1 files changed, 89 insertions, 72 deletions
@@ -1,5 +1,3 @@ -#+OPTIONS: toc:nil - @@html: <a href="https://melpa.org/#/mastodon"><img alt="MELPA" src="https://melpa.org/packages/mastodon-badge.svg"/></a>@@ @@html: <a href="https://ci.codeberg.org/martianh/mastodon.el"><img alt="Build Status" src="https://ci.codeberg.org/api/badges/martianh/mastodon.el/status.svg"></a>@@ @@ -109,69 +107,73 @@ not contain =:client_id= and =:client_secret=. **** Keybindings -|----------------+-----------------------------------------------------------------------| -| Key | Action | -|----------------+-----------------------------------------------------------------------| -| | *Help* | -| =?= | Open context menu if =discover= is available | -|----------------+-----------------------------------------------------------------------| -| | *Timeline actions* | -| =n= | Go to next item (toot, notification) | -| =p= | Go to previous item (toot, notification) | -| =M-n=/=<tab>= | Go to the next interesting thing that has an action | -| =M-p=/=<S-tab>= | Go to the previous interesting thing that has an action | -| =F= | Open federated timeline | -| =H= | Open home timeline | -| =L= | Open local timeline | -| =N= | Open notifications timeline | -| =@= | Open mentions-only notifications timeline | -| =u= | Update current timeline | -| =T= | Open thread for toot under =point= | -| =#= | Prompt for tag and open its timeline | -| =A= | Open author profile of toot under =point= | -| =P= | Open profile of user attached to toot under =point= | -| =O= | View own profile | -| =U= | update your profile bio note | -|----------------+-----------------------------------------------------------------------| -| | *Other views* | -| =S= | search (posts, users, tags) (NB: only posts you have interacted with) | -| =I=, =c=, =d= | view, create, and delete filters | -| =R=, =a=, =j= | view/accept/reject follow requests | -| =G= | view follow suggestions | -| =V= | view your favourited toots | -| =K= | view bookmarked toots | -| =X= | view/edit/create/delete lists | -|----------------+-----------------------------------------------------------------------| -| | *Toot actions* | -| =t= | Compose a new toot | -| =c= | Toggle content warning content | -| =b= | Boost toot under =point= | -| =f= | Favourite toot under =point= | -| =k= | toggle bookmark of toot at point | -| =r= | Reply to toot under =point= | -| =v= | Vote on poll at point | -| =C= | copy url of toot at point | -| =C-RET= | play video/gif at point (requires =mpv=) | -| =e= | edit your toot at point | -| =E= | view edits of toot at point | -| =i= | (un)pin your toot at point | -| =d= | delete your toot at point, and reload current timeline | -| =D= | delete and redraft toot at point, preserving reply/CW/visibility | -| (=S-C-=) =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point | -|----------------+-----------------------------------------------------------------------| -| | *Profile view* | +|----------------+---------------------------------------------------------------------------| +| Key | Action | +|----------------+---------------------------------------------------------------------------| +| | *Help* | +| =?= | Show discover menu of all bindings, if =discover= is available | +|----------------+---------------------------------------------------------------------------| +| | *Timeline actions* | +| =n= | Go to next item (toot, notification) | +| =p= | Go to previous item (toot, notification) | +| =M-n=/=<tab>= | Go to the next interesting thing that has an action | +| =M-p=/=<S-tab>= | Go to the previous interesting thing that has an action | +| =F= | Open federated timeline | +| =H= | Open home timeline | +| =L= | Open local timeline | +| =N= | Open notifications timeline | +| =@= | Open mentions-only notifications timeline | +| =u= | Update current timeline | +| =T= | Open thread for toot at point | +| =#= | Prompt for tag and open its timeline | +| =A= | Open author profile of toot at point | +| =P= | Open profile of user attached to toot at point | +| =O= | View own profile | +| =U= | update your profile bio note | +| =;= | view instance description for toot at point | +| =,= | view favouriters of toot at point | +| =.= | view boosters of toot at point | +|----------------+---------------------------------------------------------------------------| +| | *Other views* | +| =S= | search (posts, users, tags) (NB: only posts you have interacted with) | +| =I=, =c=, =d= | view, create, and delete filters | +| =R=, =a=, =j= | view/accept/reject follow requests | +| =G= | view follow suggestions | +| =V= | view your favourited toots | +| =K= | view bookmarked toots | +| =X= | view/edit/create/delete lists | +| =s= | view your scheduled toots | +|----------------+---------------------------------------------------------------------------| +| | *Toot actions* | +| =t= | Compose a new toot | +| =c= | Toggle content warning content | +| =b= | Boost toot under =point= | +| =f= | Favourite toot under =point= | +| =k= | toggle bookmark of toot at point | +| =r= | Reply to toot under =point= | +| =v= | Vote on poll at point | +| =C= | copy url of toot at point | +| =C-RET= | play video/gif at point (requires =mpv=) | +| =e= | edit your toot at point | +| =E= | view edits of toot at point | +| =i= | (un)pin your toot at point | +| =d= | delete your toot at point, and reload current timeline | +| =D= | delete and redraft toot at point, preserving reply/CW/visibility | +| (=S-C-=) =W=, =M=, =B= | (un)follow, (un)mute, (un)block author of toot at point | +|----------------+---------------------------------------------------------------------------| +| | *Profile view* | | =C-c C-c= | cycle between statuses, followers, following, and statuses without boosts | -| | =mastodon-profile--account-account-to-list= (see lists view) | -|----------------+-----------------------------------------------------------------------| -| | *Notifications view* | -| =a=, =j= | accept/reject follow request | -| =c= | clear notification at point | -| | see =mastodon-notifications--get-*= functions for filtered views | -|----------------+-----------------------------------------------------------------------| -| | *Quitting* | -| =q= | Quit mastodon buffer, leave window open | -| =Q= | Quit mastodon buffer and kill window | -|----------------+-----------------------------------------------------------------------| +| | =mastodon-profile--account-account-to-list= (see lists view) | +|----------------+---------------------------------------------------------------------------| +| | *Notifications view* | +| =a=, =j= | accept/reject follow request | +| =c= | clear notification at point | +| | see =mastodon-notifications--get-*= functions for filtered views | +|----------------+---------------------------------------------------------------------------| +| | *Quitting* | +| =q= | Quit mastodon buffer, leave window open | +| =Q= | Quit mastodon buffer and kill window | +|----------------+---------------------------------------------------------------------------| **** Toot byline legend @@ -217,7 +219,7 @@ You can download and use your instance's custom emoji | =C-c C-l= | Set toot language | |---------+----------------------------------| -**** draft toots +**** Draft toots - Compose buffer text is saved as you type, kept in =mastodon-toot-current-toot-text=. - =mastodon-toot--save-draft=: save the current toot as a draft. @@ -227,7 +229,7 @@ You can download and use your instance's custom emoji *** Other commands and account settings: -In addition to =mastodon=, the following functions are autoloaded and should +In addition to =mastodon=, the following three functions are autoloaded and should work without first loading =mastodon.el=: - =mastodon-toot=: Compose new toot - =mastodon-notifications-get=: View all notifications @@ -242,11 +244,17 @@ work without first loading =mastodon.el=: instance. +- =mastodon-tl--add-toot-account-at-point-to-list=: Add the account of the toot at point to a list. + + - =mastodon-tl--follow-tag=: Follow a tag (works like following a user) - =mastodon-tl--unfollow-tag=: Unfollow a tag - =mastodon-tl--list-followed-tags=: View a list of tags you're following. +- =mastodon-switch-to-buffer=: switch between mastodon buffers. + + - =mastodon-profile--update-display-name=: Update the display name for your account. - =mastodon-profile--update-user-profile-note=: Update your bio note. @@ -269,16 +277,25 @@ See =M-x customize-group RET mastodon= to view all customize options. - Timeline options: - Use proportional fonts + - Default number of posts displayed - Timestamp format - Relative timestamps - Display user avatars - Avatar image height - Enable image caching + - Hide replies in timelines - Compose options: - Completion style for mentions and tags - Enable custom emoji - Display toot being replied to + - Set default reply visibility + +*** Alternative timeline layout + +The incomparable Nicholas Rougier has written an alternative timeline layout for =mastodon.el=. + +The repo is at https://github.com/rougier/mastodon-alt. *** Live-updating timelines: =mastodon-async-mode= @@ -295,7 +312,7 @@ view a timeline with one of the commands that begin with *** Translating toots -You can translate toots with =mastodon-toot--translate-toot-text=. At the moment +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, to be installed to work. @@ -328,7 +345,7 @@ Optional dependencies: - =mpv= and =mpv.el= for viewing videos and gifs - =lingva.el= for translating toots -** Network compatibility. +** Network compatibility =mastodon.el= should work with ActivityPub servers that implement the Mastodon API. @@ -359,23 +376,23 @@ PRs, issues, feature requests, and general feedback are very welcome! 3. Run the tests and ensure that your code doesn't break any of them. 4. Create a pull request referencing the issue created in step 1. -*** coding style +*** Coding style - This library uses an unconvential double dash (=--=) between file namespaces and function names, which contradicts normal Elisp style. This needs to be respected until the whole library is changed. - Use =aggressive-indent-mode= or similar to keep your code indented. - Single spaces end sentences in docstrings. - There's no need for a blank line after the first docstring line (one is added automatically when documentation is displayed). -** Supporting mastodon.el +** Supporting =mastodon.el= If you'd like to support continued development of =mastodon.el=, I accept -donations via paypal: https://paypal.me/martianh. If you would +donations via paypal: [[https://paypal.me/martianh][https://paypal.me/martianh]]. If you would prefer a different payment method, write to me at that address and I can provide IBAN or other details. I don't have a tech worker's income, so even a small tip would help out. -** Contributors: +** Contributors =mastodon.el= is the work of a number of people. |