diff options
| author | jao <jao@gnu.org> | 2022-12-13 02:15:42 +0000 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2023-02-20 08:58:32 -0400 |
| commit | f63d14a8c12ad76024d2865c0223a06f6f4bb372 (patch) | |
| tree | 95c30a5aca87851264d240c4f1261288e8405c6d /doc | |
| parent | db4b48f6cc033255d0214c76bc72a05d61bff118 (diff) | |
emacs: notmuch-tree-outline-mode
With this mode, one can fold trees in the notmuch-tree buffer as if
they were outlines, using all the commands provided by
outline-minor-mode. We also define a couple of movement commands
that, optional, will ensure that only the thread around point is
unfolded.
The implementation is based on registering a :level property in the
messages p-list, that is then used by outline-minor-mode to to
recognise headers.
Amended by db: Copy docstring to manual and edit for presentation. Add
two tests. Fix typo "wether".
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/notmuch-emacs.rst | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index 846f5e67..71f10e20 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -606,6 +606,45 @@ can be controlled by the variable ``notmuch-search-oldest-first``. See also :el:defcustom:`notmuch-search-result-format` and :el:defcustom:`notmuch-unthreaded-result-format`. +.. _notmuch-tree-outline: + +notmuch-tree-outline +-------------------- + +When this mode is set, each thread and subthread in the results +list is treated as a foldable section, with its first message as +its header. + +The mode just makes available in the tree buffer all the +keybindings in info:emacs#Outline_Mode, and binds the following +additional keys: + +.. el:define-key:: <tab> + + Cycle visibility state of the current message's tree. + +.. el:define-key:: <M-tab> + + Cycle visibility state of all trees in the buffer. + +The behaviour of this minor mode is affected by the following +customizable variables: + +.. el:defcustom:: notmuch-tree-outline-enabled + + |docstring::notmuch-tree-outline-enabled| + +.. el:defcustom:: notmuch-tree-outline-visibility + + |docstring::notmuch-tree-outline-visibility| + +.. el:defcustom:: notmuch-tree-outline-auto-close + + |docstring::notmuch-tree-outline-auto-close| + +.. el:defcustom:: notmuch-tree-outline-open-on-next + + |docstring::notmuch-tree-outline-open-on-next| .. _notmuch-unthreaded: |