unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 8/8] docs: add initial documentation for notmuch-tag-jump
Date: Mon, 21 May 2018 13:08:56 -0700	[thread overview]
Message-ID: <20180521200856.17103-9-david@tethera.net> (raw)
In-Reply-To: <20180521200856.17103-1-david@tethera.net>

This is mainly to improve discoverability. It seems that doing
variable cross-references is not easy without using some sphinx
extension/customization.
---
 doc/notmuch-emacs.rst | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 1d3291b8..ce2e358e 100644
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -245,6 +245,9 @@ following key bindings:
 ``j``
     Jump to saved searches using :ref:`notmuch-jump`.
 
+``k``
+    Tagging operations using :ref:`notmuch-tag-jump`
+
 .. _notmuch-jump:
 
 notmuch-jump
@@ -258,6 +261,22 @@ example, in the default configuration ``j i`` jumps immediately to the
 inbox search.  When you press ``j``, notmuch-jump shows the saved
 searches and their shortcut keys in the mini-buffer.
 
+.. _notmuch-tag-jump:
+
+notmuch-tag-jump
+----------------
+
+Tagging operations configured through ``notmuch-tagging-keys`` can
+be accessed via :kbd:`k` in :ref:`notmuch-show`,
+:ref:`notmuch-search` and :ref:`notmuch-tree`.  With a
+prefix (:kbd:`C-u k`), notmuch displays a menu of the reverses of the
+operations specified in ``notmuch-tagging-keys``; i.e. each
+``+tag`` is replaced by ``-tag`` and vice versa.
+
+:index:`notmuch-tagging-keys`
+
+   A list of keys and corresponding tagging operations.
+
 Configuration
 =============
 
-- 
2.17.0

      parent reply	other threads:[~2018-05-21 20:09 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-21 20:08 install info docs v1 David Bremner
2018-05-21 20:08 ` [PATCH 1/8] configure: check for makeinfo and install-info David Bremner
2018-05-26 15:56   ` David Bremner
2018-05-21 20:08 ` [PATCH 2/8] configure: set 'infodir' David Bremner
2018-05-21 20:08 ` [PATCH 3/8] doc: install build and install info pages David Bremner
2018-05-21 20:08 ` [PATCH 4/8] doc: install info files in elpa package David Bremner
2018-05-21 20:08 ` [PATCH 5/8] debian: install info pages as part of elpa-emacs David Bremner
2018-05-21 22:23   ` Tomi Ollila
2018-05-21 20:08 ` [PATCH 6/8] doc: initial documentation for notmuch-show-mode David Bremner
2018-05-21 20:08 ` [PATCH 7/8] doc: initial documentation for notmuch-tree mode David Bremner
2018-05-21 20:08 ` David Bremner [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180521200856.17103-9-david@tethera.net \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).