aboutsummaryrefslogtreecommitdiffstats
path: root/doc/aerc-templates.7.scd
diff options
context:
space:
mode:
authorRobin Jarry <robin@jarry.cc>2022-12-27 22:59:10 +0100
committerRobin Jarry <robin@jarry.cc>2023-02-20 14:48:42 +0100
commitd2e74cdb91e140b50d14c3a8b315cde272f32587 (patch)
tree4f4a20c02f60b67d7a8eb967bb45d789a057453b /doc/aerc-templates.7.scd
parent6af06c9dfec03e923589d34187ba8358e3423d5c (diff)
downloadaerc-d2e74cdb91e140b50d14c3a8b315cde272f32587.tar.gz
statusline: add column based render format
In the spirit of commit 535300cfdbfc ("config: add columns based index format"), reuse the column definitions and table widget. Add automatic translation of render-format to column definitions. Allow empty columns to be compatible with the %m (mute) flag. Rename the State object to AccountState to be more precise. Reuse that object in state.TempateData to expose account state info. Move actual status line rendering in StatusLine.Draw(). Add new template fields for status specific data: {{.ConnectionInfo}} Connection state. {{.ContentInfo}} General status information (e.g. filter, search) {{.StatusInfo}} Combination of {{.ConnectionInfo}} and {{.StatusInfo}} {{.TrayInfo}} General on/off information (e.g. passthrough, threading, sorting) {{.PendingKeys}} Currently pressed key sequence that does not match any key binding and/or is incomplete. Display a warning on startup if render-format has been converted to status-columns. Signed-off-by: Robin Jarry <robin@jarry.cc> Acked-by: Tim Culverhouse <tim@timculverhouse.com>
Diffstat (limited to 'doc/aerc-templates.7.scd')
-rw-r--r--doc/aerc-templates.7.scd39
1 files changed, 39 insertions, 0 deletions
diff --git a/doc/aerc-templates.7.scd b/doc/aerc-templates.7.scd
index 71042835..8e1bcf1b 100644
--- a/doc/aerc-templates.7.scd
+++ b/doc/aerc-templates.7.scd
@@ -162,6 +162,45 @@ available always.
{{.Exists "archive" "spam" "foo/baz" "foo/bar"}}
```
+*Status line*
+
+ The following data will only be available in the status line templates:
+
+ Connection state.
+
+ ```
+ {{.Connected}}
+ {{.ConnectionInfo}}
+ ```
+
+ General status information (e.g. filter, search) separated with
+ *[statusline].separator*.
+
+ ```
+ {{.ContentInfo}}
+ ```
+
+ Combination of *{{.ConnectionInfo}}* and *{{.StatusInfo}}* separated
+ with *[statusline].separator*.
+
+ ```
+ {{.StatusInfo}}
+ ```
+
+ General on/off information (e.g. passthrough, threading, sorting),
+ separated with *[statusline].separator*.
+
+ ```
+ {{.TrayInfo}}
+ ```
+
+ Currently pressed key sequence that does not match any key binding
+ and/or is incomplete.
+
+ ```
+ {{.PendingKeys}}
+ ```
+
# TEMPLATE FUNCTIONS
Besides the standard functions described in go's text/template documentation,