diff options
author | Srivathsan Murali <sri@vathsan.com> | 2020-01-23 13:56:48 +0100 |
---|---|---|
committer | Drew DeVault <sir@cmpwn.com> | 2020-01-24 10:50:21 -0500 |
commit | b2fa5a16f52741a6f7f6e5f33561457d702dc31d (patch) | |
tree | 3c44cd8f100e0e8c156ad2bbe17ba46fb68a2e01 /doc | |
parent | aa967682bcdbeaa11b3e79d66b1d68b129dd4161 (diff) |
Contextual UI Configuration
+ Adds parsing of contextual ui sections to aerc config.
+ Add GetUiConfig method for AercConfig that is used to get the
specialized UI config.
+ Add UiConfig method to AccountView to get specialized UI Config.
+ Modifies Aerc codebase to use specialized UIConfig instead.
+ Adds documentation for Contextual UI Configuration
Diffstat (limited to 'doc')
-rw-r--r-- | doc/aerc-config.5.scd | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/doc/aerc-config.5.scd b/doc/aerc-config.5.scd index 791a39d..c747c61 100644 --- a/doc/aerc-config.5.scd +++ b/doc/aerc-config.5.scd @@ -168,6 +168,46 @@ These options are configured in the *[ui]* section of aerc.conf. Default: 250ms +## Contextual UI Configuration + +The UI configuration can be specialized for accounts, specific mail +directories and message subjects. The specializations are added using +contextual config sections based on the context. + +The contextual UI configuration is merged to the base UiConfig in the +following order: +*Base UIConfig > Account Context > Folder Context > Subject Context.* + +*[ui:account=<AccountName>]* + Adds account specific configuration with the account name. + +*[ui:folder=<FolderName>]* + Add folder specific configuration with the folder name. + +*[ui:folder~<Regex>]* + Add folder specific configuration for folders whose names match the regular + expression. + +*[ui:subject~<Regex>]* + Add specialized ui configuration for messages that match a given regular + expression. + +Example: +``` +[ui:account=Work] +sidebar-width=... + +[ui:folder=Sent] +index-format=... + +[ui:folder~Archive/\d+/.*] +index-format=... + +[ui:subject~^\[PATCH] +index-format=... +``` + + ## VIEWER These options are configured in the *[viewer]* section of aerc.conf. |