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.
This commit is contained in:
David Bremner 2018-05-21 13:08:56 -07:00
parent 7a58c1c44b
commit b50fb1b642

View file

@ -245,6 +245,9 @@ following key bindings:
``j`` ``j``
Jump to saved searches using :ref:`notmuch-jump`. Jump to saved searches using :ref:`notmuch-jump`.
``k``
Tagging operations using :ref:`notmuch-tag-jump`
.. _notmuch-jump: .. _notmuch-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 inbox search. When you press ``j``, notmuch-jump shows the saved
searches and their shortcut keys in the mini-buffer. 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 Configuration
============= =============