summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2017-11-29 10:10:39 +0000
committerPatrick Totzke <patricktotzke@gmail.com>2017-11-29 10:10:39 +0000
commit054d2a932e7cb8d18dae258750ed26fb86e650b9 (patch)
tree277063bc3354a164929704e5644164c79c9afc26 /docs
parent5bbe084d2c9428ceb7250a96a0668bc4952fcec1 (diff)
[docs] update section titles
this simply renames some (sub)section titles in the configuration docs.
Diffstat (limited to 'docs')
-rw-r--r--docs/source/configuration/hooks.rst6
-rw-r--r--docs/source/configuration/theming.rst10
2 files changed, 10 insertions, 6 deletions
diff --git a/docs/source/configuration/hooks.rst b/docs/source/configuration/hooks.rst
index 0b2b6a23..5d201328 100644
--- a/docs/source/configuration/hooks.rst
+++ b/docs/source/configuration/hooks.rst
@@ -5,7 +5,8 @@ Hooks
Hooks are python callables that live in a module specified by `hooksfile` in
the config. Per default this points to :file:`~/.config/alot/hooks.py`.
-.. rubric:: Pre/Post Command Hooks
+Pre/Post Command Hooks
+----------------------
For every :ref:`COMMAND <usage.commands>` in mode :ref:`MODE <modes>`, the
callables :func:`pre_MODE_COMMAND` and :func:`post_MODE_COMMAND` -- if defined
@@ -36,7 +37,8 @@ message::
else:
logging.info('goodbye!')
-.. rubric:: Other Hooks
+Other Hooks
+-----------
Apart from command pre- and posthooks, the following hooks will be interpreted:
diff --git a/docs/source/configuration/theming.rst b/docs/source/configuration/theming.rst
index d98db52a..caf14047 100644
--- a/docs/source/configuration/theming.rst
+++ b/docs/source/configuration/theming.rst
@@ -58,8 +58,8 @@ underlined bold red text on a bright green background:
# v v v v v v
footer = 'bold,underline', '', 'light red, bold, underline', 'light green', 'light red, bold, underline', '#8f6'
-Highlighting Thread lines in Search Mode
-----------------------------------------
+Search mode thread ines
+-------------------------
The subsection '[[threadline]]' of the '[search]' section in :ref:`Theme Files <config.theming.themefiles>`
determines how to present a thread: here, :ref:`attributes <config.theming.attributes>` 'normal' and
'focus' provide fallback/spacer themes and 'parts' is a (string) list of displayed subwidgets.
@@ -83,6 +83,8 @@ For every listed part there must be a subsection with the same name, defining
:alignment: how to place the content string if the widget space is larger.
This must be one of 'right', 'left' or 'center'.
+Dynamic theming of thread lines based on query matching
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To highlight some thread lines (use different attributes than the defaults found in the
'[[threadline]]' section), one can define sections with prefix 'threadline'.
Each one of those can redefine any part of the structure outlined above, the rest defaults to
@@ -133,8 +135,8 @@ and just bold if the thread has unread but no flagged messages:
.. _config.theming.tags:
-Custom Tagstring Formatting
----------------------------
+Tagstring Formatting
+--------------------
One can specify how a particular tagstring is displayed throughout the interface. To use this
feature, add a section `[tags]` to you alot config (not the theme file)