From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.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 AA1kKn8rgmKCDQEAbAwnHQ (envelope-from ) for ; Mon, 16 May 2022 12:46:23 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id KDZpKX8rgmJl2QAAG6o9tA (envelope-from ) for ; Mon, 16 May 2022 12:46:23 +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) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 5028F1C5DD for ; Mon, 16 May 2022 12:46:23 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 84CEE5F73C; Mon, 16 May 2022 10:46:20 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id 4E97E5F6B7 for ; Mon, 16 May 2022 10:46:17 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id 87FD85FBD7; Mon, 16 May 2022 06:46:16 -0400 (EDT) Received: (nullmailer pid 327064 invoked by uid 1000); Mon, 16 May 2022 10:46:15 -0000 From: David Bremner To: David Bremner , notmuch@notmuchmail.org Subject: [PATCH v2] doc/emacs: document a few notmuch-hello customizable variables. Date: Mon, 16 May 2022 07:46:10 -0300 Message-Id: <20220516104610.327031-1-david@tethera.net> X-Mailer: git-send-email 2.35.2 In-Reply-To: <20220408155910.117231-1-david@tethera.net> References: <20220408155910.117231-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: OWS72KYAMXQNBZSHTSNELSF33TRS2QI4 X-Message-ID-Hash: OWS72KYAMXQNBZSHTSNELSF33TRS2QI4 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=1652697983; 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=iaJN83kIOEj2yQuQUEpACjsogGOSvNTF/PN1i5P7BTU=; b=IRY9YZrImUyfCEAlI7yNiAkKOpEz/RWR9vyUEwEXdmAY1A5lVoYpUuIKcsckVOs5iJKc57 9l8EFVpXp79BLtRC2DD+j9MzbP3opcGTStmLboGP6dmaw45JGE/74SQgcWRgBtKSNFABe1 lMmYfha7HsZE0nVcNvOZdyZ2GWT0CcQBWDy4nxCPL/LqXsldzfckJKrHV2W1Hl58EaNX1l RKuMyRtHbo56sOMB4W91VOSQBVZzyCv7qrUC4F5yNsBfkmQrNblnHcjAb331ra9xaEc9SY n3ACufO9FLajUjOGSpL0O55TB8jjb6tG98l/x7y8oRCIgRSoQbqvuefCIhKkOw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1652697983; a=rsa-sha256; cv=none; b=kkSEIwCig+F4GBJoUo+q5EnyfcvFSHNbeRRINPg/Y8AeWqyJO1V8lYNzbFjIfD8fzhvIpA USivlwQwL7aMJy73auV6p7+tyYOh2LdoqKmQB/pzE02+Ydpcxq7R92TsZEk78Z8B/75QhJ 6/fReYAlGM/Hh8PQ43TfyM6PAggmUPsksH9q8eQiu7mrAA5hbgyW4NkjIYibAGkn7NrDFs /VCS9PDue/ZOIAzxsaA51lPXtudZz6TBzvITAnrVvEafeH4clBpgANjrZKmFqEw9sBJi8P 17QITbEvmv0q+EaFJ/HhyXNU2c6yMepxyNs0k55FBaxeF9nZEUd19c/WlEjCEA== 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.98 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: 5028F1C5DD X-Spam-Score: -1.98 X-Migadu-Scanner: scn0.migadu.com X-TUID: Y2kB/Q1or6OX A user asked about the thousands separator on IRC, and I had to check the source. --- I realized the docstring was getting mangled when auto-translated to rst, so I did the manual translation. doc/conf.py | 2 +- doc/notmuch-emacs.rst | 41 ++++++++++++++++++++++++++++++++++++++++- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index e46e1d4e..fee52b64 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -45,7 +45,7 @@ if tags.has('WITH_EMACS'): # Hacky reimplementation of include to workaround limitations of # sphinx-doc lines = ['.. include:: /../emacs/rstdoc.rsti\n\n'] # in the source tree - for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'): + for file in ('notmuch.rsti', 'notmuch-lib.rsti', 'notmuch-hello.rsti', 'notmuch-show.rsti', 'notmuch-tag.rsti', 'notmuch-tree.rsti'): lines.extend(open(rsti_dir+'/'+file)) rst_epilog = ''.join(lines) del lines diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index 67dbfc2b..595f8e2a 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -46,8 +46,47 @@ a mouse or by positioning the cursor and pressing ```` | Customize Notmuch or this page. You can change the overall appearance of the notmuch-hello screen by -customizing the variable :index:`notmuch-hello-sections`. +customizing the variables +:index:`notmuch-hello-sections` + |docstring::notmuch-hello-sections| + +:index:`notmuch-hello-thousands-separator` + |docstring::notmuch-hello-thousands-separator| + +:index:`notmuch-show-logo` + |docstring::notmuch-show-logo| + +:index:`!notmuch-column-control` + Controls the number of columns for saved searches/tags in notmuch view. + + This variable has three potential types of values: + + .. describe:: t + + Automatically calculate the number of columns possible based + on the tags to be shown and the window width. + + .. describe:: integer + + A lower bound on the number of characters that will + be used to display each column. + + .. describe:: float + + A fraction of the window width that is the lower bound on the + number of characters that should be used for each column. + + So: + + - if you would like two columns of tags, set this to 0.5. + + - if you would like a single column of tags, set this to 1.0. + + - if you would like tags to be 30 characters wide, set this to 30. + + - if you don't want to worry about all of this nonsense, leave + this set to `t`. notmuch-hello key bindings -- 2.35.2