From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id EK5iIKZo5mIkEQAAbAwnHQ (envelope-from ) for ; Sun, 31 Jul 2022 13:33:58 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id MBRfIKZo5mJHuAAA9RJhRA (envelope-from ) for ; Sun, 31 Jul 2022 13:33:58 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [IPv6:2a01:4f9:c011:7a79::1]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 517851ED45 for ; Sun, 31 Jul 2022 13:33:58 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 197FF5F41A; Sun, 31 Jul 2022 11:33:38 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [198.245.60.197]) by mail.notmuchmail.org (Postfix) with ESMTP id 208835E021 for ; Sun, 31 Jul 2022 11:33:34 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id 774AA5FBC8; Sun, 31 Jul 2022 07:33:33 -0400 (EDT) Received: (nullmailer pid 2850518 invoked by uid 1000); Sun, 31 Jul 2022 11:33:26 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH 7/7] doc/emacs: use define-key instead of hard-coding markup Date: Sun, 31 Jul 2022 08:33:23 -0300 Message-Id: <20220731113323.2845595-8-david@tethera.net> X-Mailer: git-send-email 2.35.2 In-Reply-To: <20220731113323.2845595-1-david@tethera.net> References: <20220731113323.2845595-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: H5OWKC6CAWUTKERSDMN3P2ZKX7RS3VRL X-Message-ID-Hash: H5OWKC6CAWUTKERSDMN3P2ZKX7RS3VRL X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1659267238; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=EnOJ/QX9oieQf9oSjAwY4MwVUqkLvFZQXJLheoQvlq8=; b=MD1dYxUBPRo3JaWCSSxrJWNeje7evX1WbHJ6zSDdpaw8v+R5+OBHovZrl+L4w3Ymb0Vr7j TqxKj8Kt77EJ4NrGOSglnE/2mUv2HFKVG8uvEdk+FVzpxyvqamZaZmbAkR2lVcNqstCrK9 3D09AOf0JWdkSUmYBLgh+w0OOMN4LSkb/NTgfTbTNPy+jQZPPg4oPMZ7EXM8pR2oPWsiBo jLM28JSu4TxhISUoIuHfwUTXOCzeZr4PqspVUJiqbYgrqjisQkHTJcr6aPwzGmvMe5khFv 6VUpL6ps5LAWVUR6mKGb+N74lVkaURolZ2oyIqRgS3pIUEDDQqiQDx6nzQsSPA== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1659267238; a=rsa-sha256; cv=none; b=l7sN6Uk/gbqmsGFNMbAzjb8bUIn8mg3YUN2n69e9HbuBSNpOkzM56cC12gi4wtsYO1GL/n ckIIK0JpE/8LgT2UmgRGKKI3HRZOXkIlWXwQ4t2Z55xqJxhrMZCC/pPM6b9g3FU9bp/kTP GUsXwjGjDtdr4pWJ1OSGQeap5GqQp/pY7ciLzLgcdWg9PxO0BGt4XLHBGh+qNQDF3OW5+E oUIQlgUsDGuUC7eOnlTqYpyug5BKbF69iCy94PG6+9yq7MSStU23T6OMoxlSkZr6iEPxOR blFeNGOb19nAUAC3GRBCZkWPyY+XJCIUOAXbQobNpAgrDEfTOzXmf6M7Qgqobw== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: -1.69 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 2a01:4f9:c011:7a79::1 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 517851ED45 X-Spam-Score: -1.69 X-Migadu-Scanner: scn0.migadu.com X-TUID: PMpKX5XUTpdu Add keys to index. Allow indexing of both keys and commands. Use standard typesetting for multiple keybindings. --- doc/notmuch-emacs.rst | 180 ++++++++++++++++++++++++++++++------------ 1 file changed, 129 insertions(+), 51 deletions(-) diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index a3ca5331..c59d567b 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -101,32 +101,42 @@ customizing the variables notmuch-hello key bindings -------------------------- -```` +.. el:define-key:: + Move to the next widget (button or text entry field) -```` +.. el:define-key:: + Move to the previous widget. -```` +.. el:define-key:: + Activate the current widget. -``g`` ``=`` +.. el:define-key:: g + = + Refresh the buffer; mainly update the counts of messages for various saved searches. -``G`` +.. el:define-key:: G + Import mail, See :ref:`importing` -``m`` +.. el:define-key:: m + Compose a message -``s`` +.. el:define-key:: s + Search the notmuch database using :ref:`notmuch-search` -``v`` +.. el:define-key:: v + Print notmuch version -``q`` +.. el:define-key:: q + Quit .. _saved-searches: @@ -200,19 +210,30 @@ The main purpose of the ``notmuch-search-mode`` buffer is to act as a menu of results that the user can explore further by pressing ```` on the appropriate line. -``n,C-n,`` +.. el:define-key:: n + C-n + + Move to next line -``p,C-p,`` +.. el:define-key:: + p + C-p + + Move to previous line -```` +.. el:define-key:: + Open thread on current line in :ref:`notmuch-show` mode -``g`` ``=`` +.. el:define-key:: g + = + Refresh the buffer -``?`` +.. el:define-key:: ? + Display full set of key bindings The presentation of results can be controlled by the following @@ -285,33 +306,43 @@ signatures, already-read messages), are hidden. You can make these parts visible by clicking with the mouse button or by pressing RET after positioning the cursor on a hidden part. -```` +.. el:define-key:: + Scroll the current message (if necessary), advance to the next message, or advance to the next thread (if already on the last message of a thread). -``c`` +.. el:define-key:: c + :ref:`show-copy` -``N`` +.. el:define-key:: N + Move to next message -``P`` +.. el:define-key:: P + Move to previous message (or start of current message) -``n`` +.. el:define-key:: n + Move to next matching message -``p`` +.. el:define-key:: p + Move to previous matching message -``+,-`` +.. el:define-key:: + + - + Add or remove arbitrary tags from the current message. -``!`` +.. el:define-key:: ! + |docstring::notmuch-show-toggle-elide-non-matching| -``?`` +.. el:define-key:: ? + Display full set of key bindings Display of messages can be controlled by the following variables; see also :ref:`show-large`. @@ -392,44 +423,70 @@ but notmuch also provides some shortcuts. These keys are available in :ref:`notmuch-show`, and :ref:`notmuch-tree`. A subset are available in :ref:`notmuch-search`. -``c F`` ``notmuch-show-stash-filename`` +.. el:define-key:: c F + M-x notmuch-show-stash-filename + |docstring::notmuch-show-stash-filename| -``c G`` ``notmuch-show-stash-git-send-email`` +.. el:define-key:: c G + M-x notmuch-show-stash-git-send-email + |docstring::notmuch-show-stash-git-send-email| -``c I`` ``notmuch-show-stash-message-id-stripped`` +.. el:define-key:: c I + M-x notmuch-show-stash-message-id-stripped + |docstring::notmuch-show-stash-message-id-stripped| -``c L`` ``notmuch-show-stash-mlarchive-link-and-go`` +.. el:define-key:: c L + M-x notmuch-show-stash-mlarchive-link-and-go + |docstring::notmuch-show-stash-mlarchive-link-and-go| -``c T`` ``notmuch-show-stash-tags`` +.. el:define-key:: c T + M-x notmuch-show-stash-tags + |docstring::notmuch-show-stash-tags| -``c c`` ``notmuch-show-stash-cc`` +.. el:define-key:: c c + M-x notmuch-show-stash-cc + |docstring::notmuch-show-stash-cc| -``c d`` ``notmuch-show-stash-date`` +.. el:define-key:: c d + M-x notmuch-show-stash-date + |docstring::notmuch-show-stash-date| -``c f`` ``notmuch-show-stash-from`` +.. el:define-key:: c f + M-x notmuch-show-stash-from + |docstring::notmuch-show-stash-from| -``c i`` ``notmuch-show-stash-message-id`` +.. el:define-key:: c i + M-x notmuch-show-stash-message-id + |docstring::notmuch-show-stash-message-id| -``c l`` ``notmuch-show-stash-mlarchive-link`` +.. el:define-key:: c l + M-x notmuch-show-stash-mlarchive-link + |docstring::notmuch-show-stash-mlarchive-link| -``c s`` ``notmuch-show-stash-subject`` +.. el:define-key:: c s + M-x notmuch-show-stash-subject + |docstring::notmuch-show-stash-subject| -``c t`` ``notmuch-show-stash-to`` +.. el:define-key:: c t + M-x notmuch-show-stash-to + |docstring::notmuch-show-stash-to| -``c ?`` - Show all available copying commands +.. el:define-key:: c ? + M-x notmuch-subkeymap-help + + Show all available copying commands .. _notmuch-tree: @@ -441,38 +498,53 @@ email archives. Each line in the buffer represents a single message giving the relative date, the author, subject, and any tags. -``c`` +.. el:define-key:: c + :ref:`show-copy` -```` +.. el:define-key:: + Displays that message. -``N`` +.. el:define-key:: N + Move to next message -``P`` +.. el:define-key:: P + Move to previous message -``n`` +.. el:define-key:: n + Move to next matching message -``p`` +.. el:define-key:: p + Move to previous matching message -``o`` ``notmuch-tree-toggle-order`` +.. el:define-key:: o + M-x notmuch-tree-toggle-order + |docstring::notmuch-tree-toggle-order| -``l`` ``notmuch-tree-filter`` +.. el:define-key:: l + M-x notmuch-tree-filter + Filter or LIMIT the current search results based on an additional query string -``t`` ``notmuch-tree-filter-by-tag`` +.. el:define-key:: t + M-x notmuch-tree-filter-by-tag + Filter the current search results based on an additional tag -``g`` ``=`` +.. el:define-key:: g + = + Refresh the buffer -``?`` +.. el:define-key:: ? + Display full set of key bindings As is the case with :ref:`notmuch-search`, the presentation of results @@ -537,13 +609,19 @@ Global key bindings Several features are accessible from most places in notmuch through the following key bindings: -``j`` +.. el:define-key:: j + Jump to saved searches using :ref:`notmuch-jump`. -``k`` +.. el:define-key:: k + Tagging operations using :ref:`notmuch-tag-jump` -``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :any:`notmuch-tag-undo` +.. el:define-key:: C-_ + C-/ + C-x u + + Undo previous tagging operation using :any:`notmuch-tag-undo` .. _notmuch-jump: -- 2.35.2