[PATCH] emacs: hello: promote '?' as the universal help key
authorJani Nikula <jani@nikula.org>
Sun, 13 Mar 2016 12:27:17 +0000 (14:27 +0200)
committerW. Trevor King <wking@tremily.us>
Sat, 20 Aug 2016 23:21:17 +0000 (16:21 -0700)
86/88fd5c5ffb53a11d68d6536f893a2e87fb75d1 [new file with mode: 0644]

diff --git a/86/88fd5c5ffb53a11d68d6536f893a2e87fb75d1 b/86/88fd5c5ffb53a11d68d6536f893a2e87fb75d1
new file mode 100644 (file)
index 0000000..8a7178f
--- /dev/null
@@ -0,0 +1,221 @@
+Return-Path: <jani@nikula.org>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+ by arlo.cworth.org (Postfix) with ESMTP id 4A2A86DE1873\r
+ for <notmuch@notmuchmail.org>; Sun, 13 Mar 2016 05:28:27 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at cworth.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -0.555\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-0.555 tagged_above=-999 required=5 tests=[AWL=0.165,\r
+  DKIM_SIGNED=0.1, DKIM_VALID=-0.1, RCVD_IN_DNSWL_LOW=-0.7,\r
+ RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01] autolearn=disabled\r
+Received: from arlo.cworth.org ([127.0.0.1])\r
+ by localhost (arlo.cworth.org [127.0.0.1]) (amavisd-new, port 10024)\r
+ with ESMTP id dfQQ3-zHvxA8 for <notmuch@notmuchmail.org>;\r
+ Sun, 13 Mar 2016 05:28:24 -0700 (PDT)\r
+Received: from mail-wm0-f45.google.com (mail-wm0-f45.google.com\r
+ [74.125.82.45]) by arlo.cworth.org (Postfix) with ESMTPS id 6F4846DE187C for\r
+ <notmuch@notmuchmail.org>; Sun, 13 Mar 2016 05:28:23 -0700 (PDT)\r
+Received: by mail-wm0-f45.google.com with SMTP id l68so70053707wml.1\r
+ for <notmuch@notmuchmail.org>; Sun, 13 Mar 2016 05:28:23 -0700 (PDT)\r
+DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=nikula-org.20150623.gappssmtp.com; s=20150623;\r
+ h=from:to:cc:subject:date:message-id;\r
+ bh=ZYGQ+JBynnF3eb5dNICUJ/h0wa4jWcmHy7b1nqxJo8s=;\r
+ b=MsXeBcEuFddHLSsDzVD0ZRYYhbf9bnWrW1UFk8lSuTgwydDjJNjilFuWvF2uRLS3xM\r
+ 7MrOKP7INWNG5r2z+MtzSdtTfZ7ftpz+Hx50bRvxVbM82xGNSQUC4d8yRKttg/YXMQcu\r
+ 3DDCJ0BSLYD905uE875J30gPTY2YAu8t1dasb8OylKT7PXC6L7Exrx4wg2JrxKwvINwY\r
+ g/1qyDhdQOOWp/SsS34j4EGy1B+ELH3Gh4PUpv6kgU3GIDozd0NTle7/Z4FYLDLw5rzh\r
+ L2TkmZl55VSAs4hgpo+mr7AENksNjZCJk2xXMfKK7ty2DQ0QsmalDQoCkGeICCveYT9z\r
+ luzg==\r
+X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;\r
+ d=1e100.net; s=20130820;\r
+ h=x-gm-message-state:from:to:cc:subject:date:message-id;\r
+ bh=ZYGQ+JBynnF3eb5dNICUJ/h0wa4jWcmHy7b1nqxJo8s=;\r
+ b=CRMXr8j7SCAcnYuyg+fxb78ob8mfjSliDRnzjrTksqsHTcwwyKQfBfPH2UnQs6ci80\r
+ apHsla3bvBW/aHq16SD2+nT4o2JL+nlevzm10LBWRSITa+PLJETsraPU7dAo4dCBaQP2\r
+ +IxJdgFsfYK4vgtytXEHvIcQ41QDfSCorGKQKHPYuq7trkuabrzyFtXZzEl3zDwGeImT\r
+ yTwOS9lpTr48/lafh+JkiK1dHCZ9Hz1dgjL0OaY0J3U62qL1KkcoEdNRL1v42cpEIRuG\r
+ +o8qd7t5Pf7bBpDsGv/FpJocc1mSKb9aqGk/g13phzuNeYL0ydC5e7OCcyhZGcHJLkxq\r
+ cx9w==\r
+X-Gm-Message-State:\r
+ AD7BkJKcBh1FfO+fA1NjThvm70L1M+DBRTwNFM73qQaNFv/J/xUzgfZ5ZG2w9MyyaGadvw==\r
+X-Received: by 10.194.201.166 with SMTP id kb6mr19346400wjc.125.1457872100589;\r
+  Sun, 13 Mar 2016 05:28:20 -0700 (PDT)\r
+Received: from localhost (mobile-access-bcee39-255.dhcp.inet.fi.\r
+ [188.238.57.255])\r
+ by smtp.gmail.com with ESMTPSA id 8sm11401671wmk.13.2016.03.13.05.28.19\r
+ (version=TLSv1/SSLv3 cipher=OTHER);\r
+ Sun, 13 Mar 2016 05:28:19 -0700 (PDT)\r
+From: Jani Nikula <jani@nikula.org>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH] emacs: hello: promote '?' as the universal help key\r
+Date: Sun, 13 Mar 2016 14:27:17 +0200\r
+Message-Id: <1457872037-22561-1-git-send-email-jani@nikula.org>\r
+X-Mailer: git-send-email 2.1.4\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.20\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+ <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <https://notmuchmail.org/mailman/options/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch/>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <https://notmuchmail.org/mailman/listinfo/notmuch>,\r
+ <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 13 Mar 2016 12:28:27 -0000\r
+\r
+Move the brief help text at the bottom of the hello screen to the\r
+notmuch-hello-mode help, and promote '?' as the universal help key\r
+across Notmuch. This unclutters the hello screen, and allows for a\r
+more verbose description in the mode help. Hopefully, this change is\r
+useful for both experienced and new users alike.\r
+\r
+While at it, improve the links to Notmuch and hello screen\r
+customization.\r
+\r
+---\r
+\r
+This obsoletes\r
+id:1450026221-23286-1-git-send-email-jani@nikula.org\r
+---\r
+ emacs/notmuch-hello.el                             | 44 +++++++++++++++++-----\r
+ test/emacs.expected-output/notmuch-hello           |  7 +---\r
+ .../emacs.expected-output/notmuch-hello-long-names |  7 +---\r
+ .../notmuch-hello-no-saved-searches                |  7 +---\r
+ .../emacs.expected-output/notmuch-hello-with-empty |  7 +---\r
+ 5 files changed, 42 insertions(+), 30 deletions(-)\r
+\r
+diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el\r
+index b42e0f24148a..8a31f9a1c52c 100644\r
+--- a/emacs/notmuch-hello.el\r
++++ b/emacs/notmuch-hello.el\r
+@@ -672,6 +672,31 @@ with `notmuch-hello-query-counts'."\r
+ (defun notmuch-hello-mode ()\r
+  "Major mode for convenient notmuch navigation. This is your entry portal into notmuch.\r
\r
++Saved searches are \"bookmarks\" for arbitrary queries. Hit RET\r
++or click on a saved search to view matching threads. Edit saved\r
++searches with the `edit' button. Type `\\[notmuch-jump-search]'\r
++in any Notmuch screen for quick access to saved searches that\r
++have shortcut keys.\r
++\r
++Type new searches in the search box and hit RET to view matching\r
++threads. Hit RET in a recent search box to re-submit a previous\r
++search. Edit it first if you like. Save a recent search to saved\r
++searches with the `save' button.\r
++\r
++Hit `\\[notmuch-search]' or `\\[notmuch-tree]' in any Notmuch\r
++screen to search for messages and view matching threads or\r
++messages, respectively. Recent searches are available in the\r
++minibuffer history.\r
++\r
++Expand the all tags view with the `show' button (and collapse\r
++again with the `hide' button). Hit RET or click on a tag name to\r
++view matching threads.\r
++\r
++Hit `\\[notmuch-refresh-this-buffer]' to refresh the screen and\r
++`\\[notmuch-bury-or-kill-this-buffer]' to quit.\r
++\r
++The screen may be customized via `\\[customize]'.\r
++\r
+ Complete list of currently available key bindings:\r
\r
+ \\{notmuch-hello-mode-map}"\r
+@@ -907,20 +932,19 @@ following:\r
+ (defun notmuch-hello-insert-footer ()\r
+   "Insert the notmuch-hello footer."\r
+   (let ((start (point)))\r
+-    (widget-insert "Type a search query and hit RET to view matching threads.\n")\r
+-    (when notmuch-search-history\r
+-      (widget-insert "Hit RET to re-submit a previous search. Edit it first if you like.\n")\r
+-      (widget-insert "Save recent searches with the `save' button.\n"))\r
+-    (when notmuch-saved-searches\r
+-      (widget-insert "Edit saved searches with the `edit' button.\n"))\r
+-    (widget-insert "Hit RET or click on a saved search or tag name to view matching threads.\n")\r
+-    (widget-insert "`=' to refresh this screen. `s' to search messages. `q' to quit.\n")\r
++    (widget-insert "Hit `?' for context-sensitive help in any Notmuch screen.\n")\r
++    (widget-insert "Customize ")\r
++    (widget-create 'link\r
++                 :notify (lambda (&rest ignore)\r
++                           (customize-group 'notmuch))\r
++                 :button-prefix "" :button-suffix ""\r
++                 "Notmuch")\r
++    (widget-insert " or ")\r
+     (widget-create 'link\r
+                  :notify (lambda (&rest ignore)\r
+                            (customize-variable 'notmuch-hello-sections))\r
+                  :button-prefix "" :button-suffix ""\r
+-                 "Customize")\r
+-    (widget-insert " this page.")\r
++                 "this page.")\r
+     (let ((fill-column (- (window-width) notmuch-hello-indent)))\r
+       (center-region start (point)))))\r
\r
+diff --git a/test/emacs.expected-output/notmuch-hello b/test/emacs.expected-output/notmuch-hello\r
+index 9ba4cfc1d560..89186082f8a9 100644\r
+--- a/test/emacs.expected-output/notmuch-hello\r
++++ b/test/emacs.expected-output/notmuch-hello\r
+@@ -8,8 +8,5 @@ Search:                                                                     .\r
\r
+ All tags: [show]\r
\r
+-       Type a search query and hit RET to view matching threads.\r
+-              Edit saved searches with the `edit' button.\r
+-  Hit RET or click on a saved search or tag name to view matching threads.\r
+-      `=' to refresh this screen. `s' to search messages. `q' to quit.\r
+-                          Customize this page.\r
++       Hit `?' for context-sensitive help in any Notmuch screen.\r
++                    Customize Notmuch or this page.\r
+diff --git a/test/emacs.expected-output/notmuch-hello-long-names b/test/emacs.expected-output/notmuch-hello-long-names\r
+index 1c8d6eb624b9..da0f3525325d 100644\r
+--- a/test/emacs.expected-output/notmuch-hello-long-names\r
++++ b/test/emacs.expected-output/notmuch-hello-long-names\r
+@@ -11,8 +11,5 @@ All tags: [hide]\r
+         52 a-very-long-tag       52 inbox                 52 unread\r
+          4 attachment             7 signed\r
\r
+-       Type a search query and hit RET to view matching threads.\r
+-              Edit saved searches with the `edit' button.\r
+-  Hit RET or click on a saved search or tag name to view matching threads.\r
+-      `=' to refresh this screen. `s' to search messages. `q' to quit.\r
+-                          Customize this page.\r
++       Hit `?' for context-sensitive help in any Notmuch screen.\r
++                    Customize Notmuch or this page.\r
+diff --git a/test/emacs.expected-output/notmuch-hello-no-saved-searches b/test/emacs.expected-output/notmuch-hello-no-saved-searches\r
+index 05475b15abee..939965fef154 100644\r
+--- a/test/emacs.expected-output/notmuch-hello-no-saved-searches\r
++++ b/test/emacs.expected-output/notmuch-hello-no-saved-searches\r
+@@ -4,8 +4,5 @@ Search:                                                                     .\r
\r
+ All tags: [show]\r
\r
+-       Type a search query and hit RET to view matching threads.\r
+-              Edit saved searches with the `edit' button.\r
+-  Hit RET or click on a saved search or tag name to view matching threads.\r
+-      `=' to refresh this screen. `s' to search messages. `q' to quit.\r
+-                          Customize this page.\r
++       Hit `?' for context-sensitive help in any Notmuch screen.\r
++                    Customize Notmuch or this page.\r
+diff --git a/test/emacs.expected-output/notmuch-hello-with-empty b/test/emacs.expected-output/notmuch-hello-with-empty\r
+index 854e0c2a22e8..97d7db26ebfa 100644\r
+--- a/test/emacs.expected-output/notmuch-hello-with-empty\r
++++ b/test/emacs.expected-output/notmuch-hello-with-empty\r
+@@ -8,8 +8,5 @@ Search:                                                                     .\r
\r
+ All tags: [show]\r
\r
+-       Type a search query and hit RET to view matching threads.\r
+-              Edit saved searches with the `edit' button.\r
+-  Hit RET or click on a saved search or tag name to view matching threads.\r
+-      `=' to refresh this screen. `s' to search messages. `q' to quit.\r
+-                          Customize this page.\r
++       Hit `?' for context-sensitive help in any Notmuch screen.\r
++                    Customize Notmuch or this page.\r
+-- \r
+2.1.4\r
+\r