From 4181f6ad074d1e65dbc4afba11a2f2985d04ca0a Mon Sep 17 00:00:00 2001
From: "Dirk-Jan C. Binnema" <djcb@djcbsoftware.nl>
Date: Thu, 20 Apr 2023 18:08:28 +0300
Subject: [PATCH] mu4e-thread: update documentation

---
 NEWS.org       | 14 ++++++++++----
 mu4e/mu4e.texi | 29 +++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+), 4 deletions(-)

diff --git a/NEWS.org b/NEWS.org
index 8469a70d..703be80f 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -1,7 +1,14 @@
 #+STARTUP:showall
 * NEWS (user visible changes & bigger non-visible ones)
 
-* 1.10 (releases on March 26, 2023)
+* 1.11.x (unreleased development build)
+
+*** mu4e
+
+    - experimental: support folding message threads (with TAB / S-TAB).
+      See the [[info:mu4e:Folding threads][manual entry]] for further details.
+
+* 1.10 (released on March 26, 2023)
 
 *** mu
 
@@ -15,7 +22,7 @@
      details.
 
    - The ~init~ command learned ~--reinit~ to reinitialize the database with the
-     setings of an exisitng one
+     setings of an existing one
 
    - The ~script~ command is gone, and integrated with ~mu~ directly, i.e. the
      scripts (when enabled) are directly visible in the ~mu~ output. Also see the
@@ -52,8 +59,7 @@
     - mu4e window management has been completely reworked and cleaned up,
       affecting the message loading as well as the window-layout. As a
       user-visible feature, there's now the =z= binding (~mu4e-view-detach~), to
-      'detach' view and alllow for keeping multiple views around; see the
-      [[info:mu4e:MSGV Detaching and reattaching][manual entry]] for further
+      'detach' view and alllow for keV Detaching and reattaching][manual entry]] for further
       details.
 
     - As a result of that, ~mu4e-split-view~ can no longer be a function; the new
diff --git a/mu4e/mu4e.texi b/mu4e/mu4e.texi
index b1854d8a..4aa5ecb8 100644
--- a/mu4e/mu4e.texi
+++ b/mu4e/mu4e.texi
@@ -1019,6 +1019,12 @@ T,t          mark whole thread, subthread
 
 x            execute actions for the marked messages
 
+threads
+-------
+S-left       goto root
+TAB          toggle threading at current level
+S-TAB        toggle all threading
+
 composition
 -----------
 R,F,C        reply/forward/compose
@@ -1098,6 +1104,29 @@ If you want to change the defaults for these settings, you can use the variables
 @code{mu4e-search-change-sorting} to change the sorting of the current search
 results.
 
+@node Folding threads
+@section Folding threads
+
+It is possible to fold threads - that is, visually collapse threads into a
+single line (and the reverse), by default using the @key{TAB} amd @key{S-TAB}
+bindings. Note that the collapsing is always for threads as a whole, not for
+sub-threads.
+
+Folding stops at the @emph{first unread message}, unless you set
+@code{mu4e-thread-fold-unread}. Similarly, when a thread has marked messages,
+the folding stops at the first marked message. Marking folded messages is not
+allowed as it is too error-prone.
+
+If you want to automatically fold all threads after a query, you can use a hook:
+@lisp
+ (add-hook 'mu4e-headers-found-hook #'mu4e-thread-fold-apply-all)
+@end lisp
+
+By default, single-child threads are @emph{not} collapsed, since it would simply
+result in replacing a single line with the collapsed one. However, if, for
+consistency you also want to fold those, you can use
+@t{mu4e-thread-fold-single-children}.
+
 @node HV Custom headers
 @section Custom headers