From b50fb1b642be5f418db56f00f4518b1d3b2c83eb Mon Sep 17 00:00:00 2001 From: David Bremner Date: Mon, 21 May 2018 13:08:56 -0700 Subject: [PATCH] docs: add initial documentation for notmuch-tag-jump 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 =============