From ae1fc657efa7e6dcbcbd79a3fe721e8f5b1f70a9 Mon Sep 17 00:00:00 2001 From: David Bremner Date: Mon, 16 May 2022 07:46:10 -0300 Subject: [PATCH] doc/emacs: document a few notmuch-hello customizable variables. A user asked about the thousands separator on IRC, and I had to check the source. --- 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 6afeac06..e4bad9f1 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 ec7dee78..78528785 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.43.0