doomemacs/modules/app/twitter/README.org

# -*- mode: doom-docs-org -*-
#+title:    :app twitter
#+subtitle: Be superficial in plain text
#+created:  October 11, 2019
#+since:    2.0.0

* Description :unfold:
Enjoy twitter from emacs.

- View various timelines side by side, e.g. user's timeline, home, etc.
- Post new tweets
- Send direct messages
- Retweet
- Follow and un-follow users
- Favorite tweets

** Maintainers
/This module has no dedicated maintainers./ [[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:][avy]]
- [[doom-package:][twittering-mode]]

** Hacks
/No hacks documented for this module./

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

This module requires:
- One of the following (for SSL connections; required by Twitter's API):
  - [[http://curl.haxx.se/][cURL]]
  - [[http://www.gnu.org/software/wget/][GNU Wget]]
  - [[http://www.openssl.org/][OpenSSL]]
  - [[http://www.gnu.org/software/gnutls/][GnuTLS]]
- [[http://www.gnupg.org/][GnuPG]], for encrypting the OAuth token, stored locally.
- [[http://www.gzip.org/][gzip]], for compressing retrieved profile pictures,
- [[http://www.imagemagick.org/][ImageMagick]], for displaying and resizing profile pictures.

  Build Emacs with ImageMagick support using the ~--with-imagemagick~ flag ([[https://git.savannah.gnu.org/cgit/emacs.git/tree/INSTALL][how
  to build Emacs from source]]).

* TODO Usage
#+begin_quote
 🔨 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* TODO Configuration
#+begin_quote
 🔨 /This module's configuration documentation is incomplete./ [[doom-contrib-module:][Complete it?]]
#+end_quote

** Commands & Keybindings
Here is a list of available commands and their default keybindings (defined in
[[./config.el][config.el]]):
| command             | key / ex command | description                                                 |
|---------------------+------------------+-------------------------------------------------------------|
| ~+twitter/quit~     | [[kbd:][q]]                | Close current window                                        |
| ~+twitter/quit-all~ | [[kbd:][Q]]                | Close all twitter windows and buffers, and delete workspace |

And when [[doom-module:][:editor evil +everywhere]] is active:
| command                                          | key / ex command | description                                                      |
|--------------------------------------------------+------------------+------------------------------------------------------------------|
| ~twittering-favorite~                            | [[kbd:][f]]                | Favorite/Like a tweet                                            |
| ~twittering-unfavorite~                          | [[kbd:][F]]                | Un-favorite/Un-like a tweet                                      |
| ~twittering-follow~                              | [[kbd:][C-f]]              | Follow user                                                      |
| ~twittering-unfollow~                            | [[kbd:][C-F]]              | Un-follow user                                                   |
| ~twittering-delete-status~                       | [[kbd:][d]]                | Delete a tweet                                                   |
| ~twittering-retweet~                             | [[kbd:][r]]                | Retweet                                                          |
| ~twittering-toggle-or-retrieve-replied-statuses~ | [[kbd:][R]]                | Toggle or retrieve replies                                       |
| ~twittering-update-status-interactive~           | [[kbd:][o]]                | Update tweets                                                    |
| ~+twitter/ace-link~                              | [[kbd:][O]]                | Open some visible link from a ~twittering-mode~ buffer using ace |
| ~twittering-search~                              | [[kbd:][/]]                | Search                                                           |
| ~twittering-goto-next-status~                    | [[kbd:][J]]                | Go to next tweet                                                 |
| ~twittering-goto-previous-status~                | [[kbd:][K]]                | Go to previous tweet                                             |
| ~twittering-goto-first-status~                   | [[kbd:][gg]]               | Go to first tweet                                                |
| ~twittering-goto-last-status~                    | [[kbd:][G]]                | Go to last tweet                                                 |
| ~twittering-goto-next-status-of-user~            | [[kbd:][gj]]               | Go to next tweet of user                                         |
| ~twittering-goto-previous-status-of-user)))~     | [[kbd:][gk]]               | Go to previous tweet of user                                     |

* Troubleshooting
[[doom-report:][Report an issue?]]

** ~twittering-mode~ overrides the [[kbd:][SPC]] key
Currently ~twittering-mode~ binds [[kbd:][SPC]], breaking its functionality as a leader
key for evil users. To work around this issue you may use [[kbd:][M-SPC]] instead.

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 🔨 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote