Initial version of "usage"
1 +`sbbs.el` has three main views/states: 2 + 3 +# Board View 4 + 5 +After invoking `M-x sbbs`, the "board view" is loaded. This is implemented using Emacs' `tabulated-list-mode`, so you can sort the columns (either by using the mouse or `tabulated-list-sort`). A thread is opened by pressing the Enter key. 6 + 7 +If you wish to refresh to thread-list, just invoke `revert-buffer` (bound go "g"). 8 + 9 +# Thread View 10 + 11 +After opening a thread and waiting for it to load, you can navigate it using the default movement keys of your Emacs installation (ie. Usually arrow keys, `C-n/C-p/C-v/M-v/...`). Beyond these, the thread view offers a few more options for easier navigation: 12 + 13 +|: Default Key :| Command | Description | 14 +|-----------------|---------------|-----------------| 15 +| n | `sbbs-read-next` | Move point to next thread | 16 +| p | `sbbs-read-previous` | Move point to previous thread | 17 +| Tab | `forward-button` | Move to next link or reference | 18 +| Return | `push-button` | Open link or show only referenced posts | 19 +| a | `sbbs-show-pop` | Undo last hiding | 20 +| A | `sbbs-show-all`| Undo all hiding | 21 +| g | `revert-buffer` | Reload a thread | 22 + 23 +Post-hiding supports references such as `>>3`, but also multiple posts `>>5,6,9` and ranges `>>14-18`. 24 + 25 +# Compose View 26 + 27 +If you want to reply to a thread, or create a new one in `sbbs`, you will need to use to compose view. This is invoked by pressing "c" (`sbbs-view-compose`) in the board view, or "r" (`sbbs-read-reply`) in the thread view. Both open a new editable buffer, that supports markup and a few markup keybindings (they are quite straightforward, and similar to AucTeX. Use "C-h b" for more details). 28 + 29 +When you want to submit your thread or reply, press "C-c C-c" (`sbbs-compose-create`), and you're done.