diff options
Diffstat (limited to 'doc/misc/modus-themes.org')
| -rw-r--r-- | doc/misc/modus-themes.org | 5562 |
1 files changed, 2418 insertions, 3144 deletions
diff --git a/doc/misc/modus-themes.org b/doc/misc/modus-themes.org index 72a4413e8df..c3de15c35ad 100644 --- a/doc/misc/modus-themes.org +++ b/doc/misc/modus-themes.org @@ -4,9 +4,9 @@ #+language: en #+options: ':t toc:nil author:t email:t num:t #+startup: content -#+macro: stable-version 3.0.0 -#+macro: release-date 2022-10-28 -#+macro: development-version 3.1.0-dev +#+macro: stable-version 4.4.0 +#+macro: release-date 2024-03-17 +#+macro: development-version 4.5.0-dev #+macro: file @@texinfo:@file{@@$1@@texinfo:}@@ #+macro: space @@texinfo:@: @@ #+macro: kbd @@texinfo:@kbd{@@$1@@texinfo:}@@ @@ -21,21 +21,26 @@ #+texinfo: @insertcopying -This manual, written by Protesilaos Stavrou, describes the customization -options for the ~modus-operandi~ and ~modus-vivendi~ themes, and provides -every other piece of information pertinent to them. +This manual, written by Protesilaos Stavrou, describes the +customization options for the Modus themes, and provides every other +piece of information pertinent to them. The documentation furnished herein corresponds to stable version -{{{stable-version}}}, released on {{{release-date}}}. Any reference to a newer -feature which does not yet form part of the latest tagged commit, is -explicitly marked as such. +{{{stable-version}}}, released on {{{release-date}}}. Any reference +to a newer feature which does not yet form part of the latest tagged +commit, is explicitly marked as such. Current development target is {{{development-version}}}. -+ Homepage: https://protesilaos.com/emacs/modus-themes. -+ Git repository: https://git.sr.ht/~protesilaos/modus-themes. -+ Mailing list: https://lists.sr.ht/~protesilaos/modus-themes. -+ Backronym: My Old Display Unexpectedly Sharpened ... themes ++ Package name (GNU ELPA): ~modus-themes~ ++ Official manual: <https://protesilaos.com/emacs/modus-themes> ++ Change log: <https://protesilaos.com/emacs/modus-themes-changelog> ++ Color palette: <https://protesilaos.com/emacs/modus-themes-colors> ++ Sample pictures: <https://protesilaos.com/emacs/modus-themes-pictures> ++ Git repositories: + + GitHub: <https://github.com/protesilaos/modus-themes> + + GitLab: <https://gitlab.com/protesilaos/modus-themes> ++ Backronym: My Old Display Unexpectedly Sharpened ... themes. #+toc: headlines 8 insert TOC here, with eight headline levels @@ -64,43 +69,53 @@ modify this GNU manual.” :custom_id: h:f0f3dbcb-602d-40cf-b918-8f929c441baf :end: -The Modus themes are designed for accessible readability. They conform -with the highest standard for color contrast between any given -combination of background and foreground values. This corresponds to -the WCAG AAA standard, which specifies a minimum rate of distance in -relative luminance of 7:1. - -Modus Operandi (~modus-operandi~) is a light theme, while Modus Vivendi -(~modus-vivendi~) is dark. Each theme's color palette is designed to meet -the needs of the numerous interfaces that are possible in the Emacs -computing environment. - -The overarching objective of this project is to always offer accessible -color combinations. There shall never be a compromise on this -principle. If there arises an inescapable trade-off between readability -and stylistic considerations, we will always opt for the former. +The Modus themes are designed for accessible readability. They +conform with the highest standard for color contrast between +combinations of background and foreground values. For small sized +text, this corresponds to the WCAG AAA standard, which specifies a +minimum rate of distance in relative luminance of 7:1. + +The Modus themes consist of eight themes, divided into four subgroups. + +- Main themes :: ~modus-operandi~ is the project's main light theme, + while ~modus-vivendi~ is its dark counterpart. These two themes are + part of the project since its inception. They are designed to cover + a broad range of needs and are, in the opinion of the author, the + reference for what a highly legible "default" theme should look + like. + +- Tinted themes :: ~modus-operandi-tinted~ and ~modus-vivendi-tinted~ + are variants of the two main themes. They slightly tone down the + intensity of the background and provide a bit more color variety. + ~modus-operandi-tinted~ has a set of base tones that are shades of + light ochre (earthly colors), while ~modus-vivendi-tinted~ gives a + night sky impression. + +- Deuteranopia themes :: ~modus-operandi-deuteranopia~ and its + companion ~modus-vivendi-deuteranopia~ are optimized for users with + red-green color deficiency. This means that they do not use red and + green hues for color-coding purposes, such as for diff removed and + added lines. Instead, they implement colors that are discernible by + users with deueteranopia or deuteranomaly (mostly yellow and blue + hues). + +- Tritanopia themes :: ~modus-operandi-tritanopia~ and its counterpart + ~modus-vivendi-tritanopia~ are optimized for users with blue-yellow + color deficiency. The idea is the same as with the deuteranopia + variants: color coding relies only on hues that are accessible to + people with tritanopia or tritanomaly, namely, shades of red and + cyan. To ensure that users have a consistently accessible experience, the -themes strive to achieve as close to full face coverage as possible +themes strive to achieve as close to full face coverage as possible, +while still targeting a curated list of well-maintained packages ([[#h:a9c8f29d-7f72-4b54-b74b-ddefe15d6a19][Face coverage]]). -Furthermore, the themes are designed to empower users with red-green -color deficiency (deuteranopia). This is achieved in three ways: - -1. The conformance with the highest legibility standard means that text - is always readable no matter the perception of its hue. - -2. Most contexts use colors on the blue-cyan-magenta-purple side of the - spectrum. Put differently, green and/or red are seldom used, thus - minimizing the potential for confusion. - - [[#h:0b26cb47-9733-4cb1-87d9-50850cb0386e][Why are colors mostly variants of blue, magenta, cyan?]]. - -3. In contexts where a red/green color-coding is unavoidable, we provide - a universal toggle to customize the themes so that a red/blue scheme - is used instead. - - [[#h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe][Option for red-green color deficiency or deuteranopia]]. +The overarching objective of this project is to always offer +accessible color combinations. There shall never be a compromise on +this principle. If there arises an inescapable trade-off between +usability and stylistic considerations, we will always opt for the +former. Starting with version 0.12.0 and onwards, the themes are built into GNU Emacs. @@ -111,12 +126,8 @@ Emacs. :end: #+cindex: Screenshots -Check the web page with [[https://protesilaos.com/emacs/modus-themes-pictures/][the screen shots]]. There are lots of scenarios -on display that draw attention to details and important aspects in the -design of the themes. They also showcase the numerous customization -options. - -[[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization options]]. +Check the web page with [[https://protesilaos.com/emacs/modus-themes-pictures/][the screen shots]]. Note that the themes are +highly customizable ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization options]]). ** Learn about the latest changes :properties: @@ -137,14 +148,21 @@ On older versions of Emacs, they can be installed using Emacs' package manager or manually from their code repository. There also exist packages for distributions of GNU/Linux. +Emacs 28 ships with ~modus-themes~ version =1.6.0=. Emacs 29 includes +version =3.0.0=. Emacs 30 provides a newer, refactored version that +thoroughly refashions how the themes are implemented and customized. +Such major versions are not backward-compatible due to the limited +resources at the maintainer's disposal to support multiple versions of +Emacs and of the themes across the years. + ** Install manually from source :properties: :custom_id: h:da3414b7-1426-46b8-8e76-47b845b76fd0 :end: In the following example, we are assuming that your Emacs files are -stored in =~/.emacs.d= and that you want to place the Modus themes in -=~/.emacs.d/modus-themes=. +stored in {{{file(~/.emacs.d)}}} and that you want to place the Modus +themes in {{{file(~/.emacs.d/modus-themes)}}}. 1. Get the source and store it in the desired path by running the following in the command line shell: @@ -218,17 +236,17 @@ They are now ready to be used: [[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable :custom_id: h:e6268471-e847-4c9d-998f-49a83257b7f1 :end: -From time to time, we receive bug reports pertaining to errors with byte -compilation. These seldom have to do with faulty code in the themes: it -might be a shortcoming of =package.el=, some regression in the current -development target of Emacs, a misconfiguration in an otherwise exotic -setup, and the like. +From time to time, we receive bug reports pertaining to errors with +byte compilation. These seldom have to do with faulty code in the +themes: it might be a shortcoming of {{{file(package.el)}}}, some +regression in the current development target of Emacs, a +misconfiguration in an otherwise exotic setup, and the like. The common solution with a stable version of Emacs is to: -1. Delete the =modus-themes= package. +1. Delete the ~modus-themes~ package. 2. Close the current Emacs session. -3. Install the =modus-themes= again. +3. Install the ~modus-themes~ again. For those building Emacs directly from source, the solution may involve reverting to an earlier commit in emacs.git. @@ -245,101 +263,139 @@ wrong. :properties: :custom_id: h:3f3c3728-1b34-437d-9d0c-b110f5b161a9 :end: -#+findex: modus-themes-load-themes -#+findex: modus-themes-toggle -#+findex: modus-themes-load-operandi -#+findex: modus-themes-load-vivendi #+cindex: Essential configuration -#+vindex: modus-themes-after-load-theme-hook + +NOTE that Emacs can load multiple themes, which typically produces +undesirable results and undoes the work of the designer. Use the +~disable-theme~ command if you are trying other themes beside the +Modus collection ([[#h:adb0c49a-f1f9-4690-868b-013a080eed68][Option for disabling other themes while loading Modus]]). Users of the built-in themes cannot ~require~ the package as usual -because there is no package to speak of. Instead, things are simpler as -all one needs is to load the theme of their preference by adding either -form to their init file: +because there is no package to speak of. Instead, things are simpler +as built-in themes are considered safe. All one needs is to load the +theme of their preference by adding either form to their init file: #+begin_src emacs-lisp (load-theme 'modus-operandi) ; Light theme (load-theme 'modus-vivendi) ; Dark theme #+end_src +Remember that there are multiple Modus themes ([[#h:f0f3dbcb-602d-40cf-b918-8f929c441baf][Overview]]). Adapt the +above snippet accordingly. + Users of packaged variants of the themes must add a few more lines to ensure that everything works as intended. First, one has to require the -main library before loading either theme: +main library before loading one of the themes: #+begin_src emacs-lisp (require 'modus-themes) #+end_src -Then it is recommended to load the individual theme files with the -helper function ~modus-themes-load-themes~: +One can activate a theme with something like the following expression, +replacing ~modus-operandi~ with their preferred Modus theme: #+begin_src emacs-lisp -;; Load the theme files before enabling a theme (else you get an error). -(modus-themes-load-themes) -#+end_src - -Once the libraries that define the themes are enabled, one can activate -a theme with either of the following expressions: - -#+begin_src emacs-lisp -(modus-themes-load-operandi) ; Light theme -;; OR -(modus-themes-load-vivendi) ; Dark theme +(load-theme 'modus-operandi :no-confirm) #+end_src Changes to the available customization options must always be evaluated -before loading a theme ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). An exception to this -norm is when using the various Custom interfaces or with commands like -{{{kbd(M-x customize-set-variable)}}}, which can optionally -automatically reload the theme ([[#h:9001527a-4e2c-43e0-98e8-3ef72d770639][Option for inhibiting theme reload]]). +before loading a theme ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). Reload a theme for +new changes to take effect. -This is how a basic setup could look like: +This is how a basic setup could look like ([[#h:b66b128d-54a4-4265-b59f-4d1ea2feb073][The require-theme for built-in Emacs themes]]): #+begin_src emacs-lisp -;;; For the built-in themes which cannot use `require': -;; Add all your customizations prior to loading the themes +;;; For the built-in themes which cannot use `require'. +(require-theme 'modus-themes) + +;; Add all your customizations prior to loading the themes. (setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) + modus-themes-bold-constructs nil) -;; Load the theme of your choice: -(load-theme 'modus-operandi) ;; OR (load-theme 'modus-vivendi) +;; Load the theme of your choice. +(load-theme 'modus-operandi) +;; Optionally define a key to switch between Modus themes. Also check +;; the user option `modus-themes-to-toggle'. (define-key global-map (kbd "<f5>") #'modus-themes-toggle) -;;; For packaged versions which must use `require': +;;; For packaged versions which must use `require'. + (require 'modus-themes) ;; Add all your customizations prior to loading the themes (setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) - -;; Load the theme files before enabling a theme -(modus-themes-load-themes) + modus-themes-bold-constructs nil) -;; Load the theme of your choice: -(modus-themes-load-operandi) ;; OR (modus-themes-load-vivendi) +;; Load the theme of your choice. +(load-theme 'modus-operandi :no-confirm) (define-key global-map (kbd "<f5>") #'modus-themes-toggle) #+end_src [[#h:e979734c-a9e1-4373-9365-0f2cd36107b8][Sample configuration with and without use-package]]. -With those granted, bear in mind a couple of technical points on -~modus-themes-load-operandi~ and ~modus-themes-load-vivendi~, as well as -~modus-themes-toggle~ which relies on them: +To disable other themes before loading a Modus theme, use something +like this: + +#+begin_src emacs-lisp +(mapc #'disable-theme custom-enabled-themes) +(load-theme 'modus-operandi :no-confirm) +#+end_src + +#+findex: modus-themes-load-theme +Instead of using the basic ~load-theme~ function, users can rely on +the ~modus-themes-load-theme~. It accepts a single argument, which is +a symbol representing the Modus theme of choice, such as: -1. Those functions call ~load-theme~. Some users prefer to opt for - ~enable-theme~ instead ([[#h:e68560b3-7fb0-42bc-a151-e015948f8a35][Differences between loading and enabling]]). +#+begin_src emacs-lisp +(modus-themes-load-theme 'modus-operandi) +#+end_src + +#+vindex: modus-themes-after-load-theme-hook +#+vindex: modus-themes-post-load-hook +The ~modus-themes-load-theme~ takes care to disable other themes, if +the user opts in ([[#h:adb0c49a-f1f9-4690-868b-013a080eed68][Option for disabling other themes while loading Modus]]). +After loading the theme of choice, this function calls the +hook ~modus-themes-after-load-theme-hook~ (alias ~modus-themes-post-load-hook~). +Users can add their own functions to this hook to make further +customizations ([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]). + +#+findex: modus-themes-toggle +#+findex: modus-themes-select +The commands ~modus-themes-toggle~ and ~modus-themes-select~ use +~modus-themes-load-theme~ internally ([[#h:4fbfed66-5a89-447a-a07d-a03f6819c5bd][Option for which themes to toggle]]). +The aforementioned hold true for them as well. + +** The ~require-theme~ for built-in Emacs themes +:PROPERTIES: +:CUSTOM_ID: h:b66b128d-54a4-4265-b59f-4d1ea2feb073 +:END: + +The version of the Modus themes that is included in Emacs CANNOT use +the standard ~require~. This is because the built-in themes are not +included in the ~load-path~ (not my decision). The ~require-theme~ +function must be used in this case as a replacement. For example: + +#+begin_src emacs-lisp +(require-theme 'modus-themes) -2. The functions will run the ~modus-themes-after-load-theme-hook~ as - their final step. This can be employed for bespoke configurations - ([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]). Experienced users may not wish to rely on - such a hook and the functions that run it: they may prefer a custom - solution ([[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]). +;; All customizations here +(setq modus-themes-bold-constructs t + modus-themes-italic-constructs t) + +;; Maybe define some palette overrides, such as by using our presets +(setq modus-themes-common-palette-overrides + modus-themes-preset-overrides-intense) + +;; Load the theme of choice (built-in themes are always "safe" so they +;; do not need the `no-require' argument of `load-theme'). +(load-theme 'modus-operandi) + +(define-key global-map (kbd "<f5>") #'modus-themes-toggle) +#+end_src ** Sample configuration with and without use-package :properties: @@ -348,70 +404,66 @@ With those granted, bear in mind a couple of technical points on #+cindex: use-package configuration #+cindex: sample configuration +What follows is a variant of what we demonstrate in the previous +section ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). + It is common for Emacs users to rely on ~use-package~ for declaring package configurations in their setup. We use this as an example: #+begin_src emacs-lisp -;;; For the built-in themes which cannot use `require': +;;; For the built-in themes which cannot use `require'. (use-package emacs - :init + :config + (require-theme 'modus-themes) ; `require-theme' is ONLY for the built-in Modus themes + ;; Add all your customizations prior to loading the themes (setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) - :config - ;; Load the theme of your choice: - (load-theme 'modus-operandi) ;; OR (load-theme 'modus-vivendi) - :bind ("<f5>" . modus-themes-toggle)) + modus-themes-bold-constructs nil) + + ;; Maybe define some palette overrides, such as by using our presets + (setq modus-themes-common-palette-overrides + modus-themes-preset-overrides-intense) + + ;; Load the theme of your choice. + (load-theme 'modus-operandi) + + (define-key global-map (kbd "<f5>") #'modus-themes-toggle)) -;;; For packaged versions which must use `require': +;;; For packaged versions which must use `require'. (use-package modus-themes - :ensure - :init + :ensure t + :config ;; Add all your customizations prior to loading the themes (setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) + modus-themes-bold-constructs nil) - ;; Load the theme files before enabling a theme - (modus-themes-load-themes) - :config - ;; Load the theme of your choice: - (modus-themes-load-operandi) ;; OR (modus-themes-load-vivendi) - :bind ("<f5>" . modus-themes-toggle)) + ;; Maybe define some palette overrides, such as by using our presets + (setq modus-themes-common-palette-overrides + modus-themes-preset-overrides-intense) + + ;; Load the theme of your choice. + (load-theme 'modus-operandi) + + (define-key global-map (kbd "<f5>") #'modus-themes-toggle)) #+end_src The same without ~use-package~: #+begin_src emacs-lisp -;;; For the built-in themes which cannot use `require': -;; Add all your customizations prior to loading the themes -(setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) - -;; Load the theme of your choice: -(load-theme 'modus-operandi) ;; OR (load-theme 'modus-vivendi) - -(define-key global-map (kbd "<f5>") #'modus-themes-toggle) - - - -;;; For packaged versions which must use `require': -(require 'modus-themes) +(require 'modus-themes) ; OR for the built-in themes: (require-theme 'modus-themes) ;; Add all your customizations prior to loading the themes (setq modus-themes-italic-constructs t - modus-themes-bold-constructs nil - modus-themes-region '(bg-only no-extend)) + modus-themes-bold-constructs nil) -;; Load the theme files before enabling a theme -(modus-themes-load-themes) +;; Maybe define some palette overrides, such as by using our presets +(setq modus-themes-common-palette-overrides + modus-themes-preset-overrides-intense) ;; Load the theme of your choice: -(modus-themes-load-operandi) ;; OR (modus-themes-load-vivendi) +(load-theme 'modus-operandi :no-confirm) (define-key global-map (kbd "<f5>") #'modus-themes-toggle) #+end_src @@ -433,8 +485,8 @@ package declaration of the themes. The reason we recommend ~load-theme~ instead of the other option of ~enable-theme~ is that the former does a kind of "reset" on the face specs. It quite literally loads (or reloads) the theme. Whereas the -latter simply puts an already loaded theme at the top of the list of -enabled items, re-using whatever state was last loaded. +~enable-theme~ function simply puts an already loaded theme to the top +of the list of enabled items, re-using whatever state was last loaded. As such, ~load-theme~ reads all customizations that may happen during any given Emacs session: even after the initial setup of a theme. @@ -453,10 +505,13 @@ session, are better off using something like this: #+begin_src emacs-lisp (require 'modus-themes) + +;; Activate your desired themes here (load-theme 'modus-operandi t t) (load-theme 'modus-vivendi t t) -(enable-theme 'modus-operandi) ;; OR (enable-theme 'modus-vivendi) +;; Enable the preferred one +(enable-theme 'modus-operandi) #+end_src [[#h:b40aca50-a3b2-4c43-be58-2c26fcd14237][Toggle themes without reloading them]]. @@ -467,198 +522,128 @@ With the above granted, other sections of the manual discuss how to configure custom faces, where ~load-theme~ is expected, though ~enable-theme~ could still apply in stable setups: -[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. - -* Customization Options +* Customization options :properties: :custom_id: h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f :end: The Modus themes are highly configurable, though they should work well -without any further tweaks. By default, all customization options are -set to nil, unless otherwise noted in this manual. +without any further tweaks. We provide a variety of user options. +The following code block provides an overview. In addition to those +variables, the themes support a comprehensive system of overrides: it +can be used to make thoroughgoing changes to the looks of the themes +([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). We document everything at length in +the pages of this manual and also provide ready-to-use code samples. Remember that all customization options must be evaluated before loading a theme ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). If the theme is already active, it must be -reloaded for changes in user options to come into force. - -Below is a summary of what you will learn in the subsequent sections of -this manual. +reloaded for changes to take effect. #+begin_src emacs-lisp +;; In all of the following, WEIGHT is a symbol such as `semibold', +;; `light', `bold', or anything mentioned in `modus-themes-weights'. (setq modus-themes-italic-constructs t modus-themes-bold-constructs nil - modus-themes-mixed-fonts nil - modus-themes-subtle-line-numbers nil - modus-themes-intense-mouseovers nil - modus-themes-deuteranopia t - modus-themes-tabs-accented t + modus-themes-mixed-fonts t modus-themes-variable-pitch-ui nil - modus-themes-inhibit-reload t ; only applies to `customize-set-variable' and related - - modus-themes-fringes nil ; {nil,'subtle,'intense} - - ;; Options for `modus-themes-lang-checkers' are either nil (the - ;; default), or a list of properties that may include any of those - ;; symbols: `straight-underline', `text-also', `background', - ;; `intense' OR `faint'. - modus-themes-lang-checkers nil - - ;; Options for `modus-themes-mode-line' are either nil, or a list - ;; that can combine any of `3d' OR `moody', `borderless', - ;; `accented', a natural number for extra padding (or a cons cell - ;; of padding and NATNUM), and a floating point for the height of - ;; the text relative to the base font size (or a cons cell of - ;; height and FLOAT) - modus-themes-mode-line '(accented borderless (padding . 4) (height . 0.9)) - - ;; Same as above: - ;; modus-themes-mode-line '(accented borderless 4 0.9) - - ;; Options for `modus-themes-markup' are either nil, or a list - ;; that can combine any of `bold', `italic', `background', - ;; `intense'. - modus-themes-markup '(background italic) - - ;; Options for `modus-themes-syntax' are either nil (the default), - ;; or a list of properties that may include any of those symbols: - ;; `faint', `yellow-comments', `green-strings', `alt-syntax' - modus-themes-syntax nil - - ;; Options for `modus-themes-hl-line' are either nil (the default), - ;; or a list of properties that may include any of those symbols: - ;; `accented', `underline', `intense' - modus-themes-hl-line '(underline accented) - - ;; Options for `modus-themes-paren-match' are either nil (the - ;; default), or a list of properties that may include any of those - ;; symbols: `bold', `intense', `underline' - modus-themes-paren-match '(bold intense) - - ;; Options for `modus-themes-links' are either nil (the default), - ;; or a list of properties that may include any of those symbols: - ;; `neutral-underline' OR `no-underline', `faint' OR `no-color', - ;; `bold', `italic', `background' - modus-themes-links '(neutral-underline background) - - ;; Options for `modus-themes-box-buttons' are either nil (the - ;; default), or a list that can combine any of `flat', `accented', - ;; `faint', `variable-pitch', `underline', `all-buttons', the - ;; symbol of any font weight as listed in `modus-themes-weights', - ;; and a floating point number (e.g. 0.9) for the height of the - ;; button's text. - modus-themes-box-buttons '(variable-pitch flat faint 0.9) + modus-themes-custom-auto-reload t + modus-themes-disable-other-themes t ;; Options for `modus-themes-prompts' are either nil (the ;; default), or a list of properties that may include any of those - ;; symbols: `background', `bold', `gray', `intense', `italic' - modus-themes-prompts '(intense bold) + ;; symbols: `italic', `WEIGHT' + modus-themes-prompts '(italic bold) - ;; The `modus-themes-completions' is an alist that reads three - ;; keys: `matches', `selection', `popup'. Each accepts a nil - ;; value (or empty list) or a list of properties that can include - ;; any of the following (for WEIGHT read further below): + ;; The `modus-themes-completions' is an alist that reads two + ;; keys: `matches', `selection'. Each accepts a nil value (or + ;; empty list) or a list of properties that can include any of + ;; the following (for WEIGHT read further below): ;; - ;; `matches' - `background', `intense', `underline', `italic', WEIGHT - ;; `selection' - `accented', `intense', `underline', `italic', `text-also' WEIGHT - ;; `popup' - same as `selected' - ;; `t' - applies to any key not explicitly referenced (check docs) - ;; - ;; WEIGHT is a symbol such as `semibold', `light', or anything - ;; covered in `modus-themes-weights'. Bold is used in the absence - ;; of an explicit WEIGHT. - modus-themes-completions '((matches . (extrabold)) - (selection . (semibold accented)) - (popup . (accented intense))) - - modus-themes-mail-citations nil ; {nil,'intense,'faint,'monochrome} - - ;; Options for `modus-themes-region' are either nil (the default), - ;; or a list of properties that may include any of those symbols: - ;; `no-extend', `bg-only', `accented' - modus-themes-region '(bg-only no-extend) - - ;; Options for `modus-themes-diffs': nil, 'desaturated, 'bg-only - modus-themes-diffs 'desaturated + ;; `matches' :: `underline', `italic', `WEIGHT' + ;; `selection' :: `underline', `italic', `WEIGHT' + modus-themes-completions + '((matches . (extrabold)) + (selection . (semibold italic text-also))) modus-themes-org-blocks 'gray-background ; {nil,'gray-background,'tinted-background} - modus-themes-org-agenda ; this is an alist: read the manual or its doc string - '((header-block . (variable-pitch 1.3)) - (header-date . (grayscale workaholic bold-today 1.1)) - (event . (accented varied)) - (scheduled . uniform) - (habit . traffic-light)) + ;; The `modus-themes-headings' is an alist: read the manual's + ;; node about it or its doc string. Basically, it supports + ;; per-level configurations for the optional use of + ;; `variable-pitch' typography, a height value as a multiple of + ;; the base font size (e.g. 1.5), and a `WEIGHT'. + modus-themes-headings + '((1 . (variable-pitch 1.5)) + (2 . (1.3)) + (agenda-date . (1.3)) + (agenda-structure . (variable-pitch light 1.8)) + (t . (1.1)))) - modus-themes-headings ; this is an alist: read the manual or its doc string - '((1 . (overline background variable-pitch 1.3)) - (2 . (rainbow overline 1.1)) - (t . (semibold)))) +;; Remember that more (MUCH MORE) can be done with overrides, which we +;; document extensively in this manual. #+end_src -** Option for inhibiting theme reload +** Option for reloading the theme on custom change :properties: :alt_title: Custom reload theme :description: Toggle auto-reload of the theme when setting custom variables :custom_id: h:9001527a-4e2c-43e0-98e8-3ef72d770639 :end: -#+vindex: modus-themes-inhibit-reload +#+vindex: modus-themes-custom-auto-reload Brief: Toggle reloading of the active theme when an option is changed -through the Customize UI. +through the Custom UI. -Symbol: ~modus-themes-inhibit-reload~ (=boolean= type) +Symbol: ~modus-themes-custom-auto-reload~ (=boolean= type) Possible values: 1. ~nil~ 2. ~t~ (default) -By default, customizing a theme-related user option through the Custom -interfaces or with {{{kbd(M-x customize-set-variable)}}} will not reload the -currently active Modus theme. +All theme user options take effect when a theme is loaded. Any +subsequent changes require the theme to be reloaded. -Enable this behavior by setting this variable to ~nil~. +When this variable has a non-~nil~ value, any change made via the Custom +UI or related functions such as ~customize-set-variable~ and ~setopt~ +(Emacs 29), will trigger a reload automatically. -Regardless of this option, the active theme must be reloaded for changes -to user options to take effect ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). +With a ~nil~ value, changes to user options have no further consequences: +the user must manually reload the theme ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). -** Option for red-green color deficiency or deuteranopia +** Option for disabling other themes while loading Modus :properties: -:alt_title: Deuteranopia style -:description: Toggle red/blue color-coding instead of red/green -:custom_id: h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe +:alt_title: Disable other themes +:description: Determine whether loading a Modus themes disables all others +:custom_id: h:adb0c49a-f1f9-4690-868b-013a080eed68 :end: -#+vindex: modus-themes-deuteranopia +#+vindex: modus-themes-disable-other-themes -Brief: When non-~nil~ use red/blue color-coding instead of red/green, -where appropriate. +Brief: Disable all other themes when loading a Modus theme. -Symbol: ~modus-themes-deuteranopia~ (=boolean= type) +Symbol: ~modus-themes-disable-other-themes~ (=boolean= type) Possible values: -1. ~nil~ (default) -2. ~t~ +1. ~nil~ +2. ~t~ (default) -This is to account for red-green color deficiency, also know as -deuteranopia and variants. It applies to all contexts where there can -be a color-coded distinction between failure or success, a to-do or done -state, a mark for deletion versus a mark for selection (e.g. in Dired), -current and lazily highlighted search matches, removed lines in diffs as -opposed to added ones, and so on. +When the value is non-~nil~, the commands ~modus-themes-toggle~ and +~modus-themes-select~, as well as the ~modus-themes-load-theme~ +function, will disable all other themes while loading the specified +Modus theme ([[#h:4fbfed66-5a89-447a-a07d-a03f6819c5bd][Option for which themes to toggle]]). This is done to +ensure that Emacs does not blend two or more themes: such blends lead +to awkward results that undermine the work of the designer. -Note that this does not change all colors throughout the active theme, -but only applies to cases that have color-coding significance. For -example, regular code syntax highlighting is not affected. There is no -such need because of the themes' overarching commitment to the highest -legibility standard, which ensures that text is readable regardless of -hue, as well as the predominance of colors on the -blue-cyan-magenta-purple side of the spectrum. +When the value is ~nil~, the aforementioned commands and function will +only disable other themes within the Modus collection. -[[#h:0b26cb47-9733-4cb1-87d9-50850cb0386e][Why are colors mostly variants of blue, magenta, cyan?]]. +This option is provided because Emacs themes are not necessarily +limited to colors/faces: they can consist of an arbitrary set of +customizations. Users who use such customization bundles must set +this variable to a ~nil~ value. ** Option for more bold constructs :properties: @@ -680,9 +665,9 @@ Possible values: The default is to use a bold typographic weight only when it is required. -With a non-~nil~ value (~t~) display several syntactic constructs in bold -weight. This concerns keywords and other important aspects of code -syntax. It also affects certain mode line indicators and command-line +With a non-~nil~ value (~t~) display several syntactic constructs in +bold weight. This concerns keywords and other important aspects of +code syntax. It also affects certain mode line indicators and command prompts. Advanced users may also want to configure the exact attributes of the @@ -718,69 +703,31 @@ Advanced users may also want to configure the exact attributes of the [[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. -** Option for syntax highlighting -:properties: -:alt_title: Syntax styles -:description: Choose the overall aesthetic of code syntax -:custom_id: h:c119d7b2-fcd4-4e44-890e-5e25733d5e52 -:end: -#+vindex: modus-themes-syntax - -Brief: Set the overall style of code syntax highlighting. - -Symbol: ~modus-themes-syntax~ (=choice= type, list of properties) - -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: - -+ ~faint~ -+ ~yellow-comments~ -+ ~green-strings~ -+ ~alt-syntax~ - -The default (a ~nil~ value or an empty list) is to use a balanced -combination of colors on the cyan-blue-magenta side of the spectrum. -There is little to no use of greens, yellows, and reds. Comments are -gray, strings are blue colored, doc strings are a shade of cyan, while -color combinations are designed to avoid exaggerations. - -The property ~faint~ fades the saturation of all applicable colors, where -that is possible or appropriate. - -The property ~yellow-comments~ applies a yellow color to comments. - -The property ~green-strings~ applies a green color to strings and a green -tint to doc strings. - -The property ~alt-syntax~ changes the combination of colors beyond strings -and comments, so that the effective palette is broadened to provide -greater variety relative to the default. - -Combinations of any of those properties are expressed as a list, like in -these examples: +** Option for which themes to toggle +:PROPERTIES: +:CUSTOM_ID: h:4fbfed66-5a89-447a-a07d-a03f6819c5bd +:END: +#+vindex: modus-themes-to-toggle -#+begin_src emacs-lisp -(faint) -(green-strings yellow-comments) -(alt-syntax green-strings yellow-comments) -(faint alt-syntax green-strings yellow-comments) -#+end_src +Brief: Choose to Modus themes to toggle between -The order in which the properties are set is not significant. +Symbol: ~modus-themes-to-toggle~ (=list= type) -In user configuration files the form may look like this: +Default value: ='(modus-operandi modus-vivendi)= -#+begin_src emacs-lisp -(setq modus-themes-syntax '(faint alt-syntax)) -#+end_src - -Independent of this variable, users may also control the use of a bold -weight or italic text: ~modus-themes-bold-constructs~ and -~modus-themes-italic-constructs~. +Possible values: -[[#h:b25714f6-0fbe-41f6-89b5-6912d304091e][Option for more bold constructs]]. +- ~modus-operandi~ +- ~modus-vivendi~ +- ~modus-operandi-tinted~ +- ~modus-vivendi-tinted~ +- ~modus-operandi-deuteranopia~ +- ~modus-vivendi-deuteranopia~ +- ~modus-operandi-tritanopia~ +- ~modus-vivendi-tritanopia~ -[[#h:977c900d-0d6d-4dbb-82d9-c2aae69543d6][Option for more italic constructs]]. +Specify two themes to toggle between using the command +~modus-themes-toggle~. ** Option for font mixing :properties: @@ -805,76 +752,62 @@ tables and code blocks to always inherit from the ~fixed-pitch~ face. This is to ensure that certain constructs like code blocks and tables remain monospaced even when users opt for a mode that remaps typeface families, such as the built-in {{{kbd(M-x variable-pitch-mode)}}}. Otherwise -the layout would appear broken, due to how spacing is done. +the layout can appear broken, due to how spacing is done. For a consistent experience, user may need to specify the font family of the ~fixed-pitch~ face. [[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. -Furthermore, users may prefer to use another package for handling mixed -typeface configurations, rather than letting the theme do it, perhaps -because a purpose-specific package has extra functionality. Two -possible options are ~org-variable-pitch~ and ~mixed-pitch~. - -** Option for links +** Option for command prompt styles :properties: -:alt_title: Link styles -:description: Choose among several styles, with or without underline -:custom_id: h:5808be52-361a-4d18-88fd-90129d206f9b +:alt_title: Command prompts +:description: Control the style of command prompts +:custom_id: h:db5a9a7c-2928-4a28-b0f0-6f2b9bd52ba1 :end: -#+vindex: modus-themes-links +#+vindex: modus-themes-prompts -Brief: Control the style of links to web pages, files, buffers... +Brief: Control the style of command prompts (e.g. minibuffer, shell, IRC +clients). -Symbol: ~modus-themes-links~ (=choice= type, list of properties) +Symbol: ~modus-themes-prompts~ (=choice= type, list of properties) Possible values are expressed as a list of properties (default is ~nil~ or an empty list). The list can include any of the following symbols: -+ Underline style: - - ~neutral-underline~ - - ~no-underline~ -+ Text coloration: - - ~faint~ - - ~no-color~ -+ ~bold~ + ~italic~ -+ ~background~ - -The default (a ~nil~ value or an empty list) is a prominent text color, -typically blue, with an underline of the same color. - -For the style of the underline, a ~neutral-underline~ property turns the -color of the line into a subtle gray, while the ~no-underline~ property -removes the line altogether. If both of those are set, the latter takes -precedence. - -For text coloration, a ~faint~ property desaturates the color of the text -and the underline, unless the underline is affected by the -aforementioned properties. While a ~no-color~ property removes the color -from the text. If both of those are set, the latter takes precedence. - -A ~bold~ property applies a heavy typographic weight to the text of the -link. ++ ~italic~ ++ A font weight, which must be supported by the underlying typeface: + - ~thin~ + - ~ultralight~ + - ~extralight~ + - ~light~ + - ~semilight~ + - ~regular~ + - ~medium~ + - ~semibold~ + - ~bold~ + - ~heavy~ + - ~extrabold~ + - ~ultrabold~ -An ~italic~ property adds a slant to the link's text (italic or oblique -forms, depending on the typeface). +The default (a ~nil~ value or an empty list) means to only use a subtle +colored foreground color. -A ~background~ property applies a subtle tinted background color. +The ~italic~ property adds a slant to the font's forms (italic or +oblique forms, depending on the typeface). -In case both ~no-underline~ and ~no-color~ are set, then a subtle gray -background is applied to all links. This can still be combined with the -~bold~ and ~italic~ properties. +The symbol of a font weight attribute such as ~light~, ~semibold~, et +cetera, adds the given weight to links. Valid symbols are defined in +the variable ~modus-themes-weights~. The absence of a weight means +that the one of the underlying text will be used. -Combinations of any of those properties are expressed as a list, -like in these examples: +Combinations of any of those properties are expressed as a list, like in +these examples: #+begin_src emacs-lisp -(faint) -(no-underline faint) -(no-color no-underline bold) -(italic bold background no-color no-underline) +(bold italic) +(italic semibold) #+end_src The order in which the properties are set is not significant. @@ -882,158 +815,181 @@ The order in which the properties are set is not significant. In user configuration files the form may look like this: #+begin_src emacs-lisp -(setq modus-themes-links '(neutral-underline background)) +(setq modus-themes-prompts '(extrabold italic)) #+end_src -The placement of the underline, meaning its proximity to the text, is -controlled by ~x-use-underline-position-properties~, -~x-underline-at-descent-line~, ~underline-minimum-offset~. Please refer to -their documentation strings. +[[#h:bd75b43a-0bf1-45e7-b8b4-20944ca8b7f8][Make prompts more or less colorful]]. -** Option for box buttons +** Option for completion framework aesthetics :properties: -:alt_title: Box buttons -:description: Choose among several styles for buttons -:custom_id: h:8b85f711-ff40-45b0-b7fc-4727503cd2ec +:alt_title: Completion UIs +:description: Choose among several styles for completion UIs +:custom_id: h:f1c20c02-7b34-4c35-9c65-99170efb2882 :end: -#+vindex: modus-themes-box-buttons - -Brief: Control the style of buttons in the Custom UI and related. +#+vindex: modus-themes-completions -Symbol: ~modus-themes-box-buttons~ (=choice= type, list of properties) +Brief: Set the overall style of completion framework interfaces. -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +Symbol: ~modus-themes-completions~ (=alist= type properties) -+ ~flat~ -+ ~accented~ -+ ~faint~ -+ ~variable-pitch~ -+ ~underline~ -+ A font weight, which must be supported by the underlying typeface: - - ~thin~ - - ~ultralight~ - - ~extralight~ - - ~light~ - - ~semilight~ - - ~regular~ - - ~medium~ - - ~semibold~ - - ~bold~ - - ~heavy~ - - ~extrabold~ - - ~ultrabold~ -+ A floating point as a height multiple of the default or a cons cell in - the form of =(height . FLOAT)= -+ ~all-buttons~ +This affects Company, Corfu, Flx, Icomplete/Fido, Ido, Ivy, Orderless, +Vertico, and the standard =*Completions*= buffer. The value is an +alist of expressions, each of which takes the form of =(KEY . LIST-OF-PROPERTIES)=. +=KEY= is a symbol, while =PROPERTIES= is a list. Here is a sample, +followed by a description of the particularities: -The default (a ~nil~ value or an empty list) is a gray background -combined with a pseudo three-dimensional effect. +#+begin_src emacs-lisp +(setq modus-themes-completions + '((matches . (extrabold underline)) + (selection . (semibold italic)))) +#+end_src -The ~flat~ property makes the button two dimensional. +The ~matches~ key refers to the highlighted characters that correspond +to the user's input. When its properties are ~nil~ or an empty list, +matching characters in the user interface will have a bold weight and +a colored foreground. The list of properties may include any of the +following symbols regardless of the order they may appear in: -The ~accented~ property changes the background from gray to an accent -color. +- ~underline~ to draw a line below the characters; -The ~faint~ property reduces the overall coloration. +- ~italic~ to use a slanted font (italic or oblique forms); -The ~variable-pitch~ property applies a proportionately spaced typeface -to the button~s text. +- The symbol of a font weight attribute such as ~light~, + ~semibold~, et cetera. Valid symbols are defined in the + variable ~modus-themes-weights~. The absence of a weight means + that bold will be used. -[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. +The ~selection~ key applies to the current line or currently matched +candidate, depending on the specifics of the user interface. When its +properties are ~nil~ or an empty list, it has a subtle gray background, +a bold weight, and the base foreground value for the text. The list +of properties it accepts is as follows (order is not significant): -The ~underline~ property draws a line below the affected text and -removes whatever box effect. This is optimal when Emacs runs inside a -terminal emulator ([[#h:fbb5e254-afd6-4313-bb05-93b3b4f67358][More accurate colors in terminal emulators]]). If -~flat~ and ~underline~ are defined together, the latter takes -precedence. +- ~underline~ to draw a line below the characters; -The symbol of a weight attribute adjusts the font of the button -accordingly, such as ~light~, ~semibold~, etc. Valid symbols are -defined in the variable ~modus-themes-weights~. +- ~italic~ to use a slanted font (italic or oblique forms); -[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. +- The symbol of a font weight attribute such as ~light~, + ~semibold~, et cetera. Valid symbols are defined in the + variable ~modus-themes-weights~. The absence of a weight means + that bold will be used. -A number, expressed as a floating point (e.g. =0.9=), adjusts the height -of the button's text to that many times the base font size. The default -height is the same as =1.0=, though it need not be explicitly stated. -Instead of a floating point, an acceptable value can be in the form of a -cons cell like =(height . FLOAT)= or =(height FLOAT)=, where FLOAT is -the given number. +Apart from specifying each key separately, a catch-all list is +accepted. This is only useful when the desired aesthetic is the same +across all keys that are not explicitly referenced. For example, +this: -The ~all-buttons~ property extends the box button effect (or the -aforementioned properties) to the faces of the generic widget library. -By default, those do not look like the buttons of the Custom UI as they -are ordinary text wrapped in square brackets. +#+begin_src emacs-lisp +(setq modus-themes-completions + '((t . (extrabold underline)))) +#+end_src -Combinations of any of those properties are expressed as a list, -like in these examples: +Is the same as: #+begin_src emacs-lisp -(flat) -(variable-pitch flat) -(variable-pitch flat semibold 0.9) -(variable-pitch flat semibold (height 0.9)) ; same as above -(variable-pitch flat semibold (height . 0.9)) ; same as above +(setq modus-themes-completions + '((matches . (extrabold underline)) + (selection . (extrabold underline)))) #+end_src -The order in which the properties are set is not significant. +[[#h:d959f789-0517-4636-8780-18123f936f91][Make completion matches more or less colorful]]. -In user configuration files the form may look like this: +** Option for org-mode block styles +:properties: +:alt_title: Org mode blocks +:description: Choose among plain, gray, or tinted backgrounds +:custom_id: h:b7e328c0-3034-4db7-9cdf-d5ba12081ca2 +:end: +#+vindex: modus-themes-org-blocks -#+begin_src emacs-lisp -(setq modus-themes-box-buttons '(variable-pitch flat 0.9)) -#+end_src +As part of version =4.4.0=, the ~modus-themes-org-blocks~ is no more. +Users can apply palette overrides to set a style that fits their +preference (purple, blue, yellow, green, etc.). It is more flexible +and more powerful ([[#h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50][DIY Make Org block colors more or less colorful]]) -** Option for command prompt styles +For the option to change the background of Org source blocks, we +provide the relevant setup ([[#h:8c842804-43b7-4287-b4e9-8c07d04d1f89][DIY Use colored Org source blocks per language]]). + +** Option for the headings' overall style :properties: -:alt_title: Command prompts -:description: Choose among plain, subtle, or intense prompts -:custom_id: h:db5a9a7c-2928-4a28-b0f0-6f2b9bd52ba1 +:alt_title: Heading styles +:description: Choose among several styles, also per heading level +:custom_id: h:271eff19-97aa-4090-9415-a6463c2f9ae1 :end: -#+vindex: modus-themes-prompts +#+vindex: modus-themes-headings -Brief: Control the style of command prompts (e.g. minibuffer, shell, IRC -clients). +Brief: Heading styles with optional list of values per heading level. -Symbol: ~modus-themes-prompts~ (=choice= type, list of properties) +Symbol: ~modus-themes-headings~ (=alist= type, multiple properties) -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +This is an alist that accepts a =(KEY . LIST-OF-VALUES)= combination. +The =KEY= is either a number, representing the heading's level (0 +through 8) or ~t~, which pertains to the fallback style. The named +keys =agenda-date= and =agenda-structure= apply to the Org agenda. -+ ~background~ -+ ~bold~ -+ ~gray~ -+ ~intense~ -+ ~italic~ +Level 0 is a special heading: it is used for what counts as a document +title or equivalent, such as the =#+title= construct we find in Org +files. Levels 1-8 are regular headings. -The default (a ~nil~ value or an empty list) means to only use a subtle -accented foreground color. +The =LIST-OF-VALUES= covers symbols that refer to properties, as +described below. Here is a complete sample with various stylistic +combinations, followed by a presentation of all available properties: + +#+begin_src emacs-lisp +(setq modus-themes-headings + '((1 . (variable-pitch 1.5)) + (2 . (1.3)) + (agenda-date . (1.3)) + (agenda-structure . (variable-pitch light 1.8)) + (t . (1.1)))) +#+end_src + +Properties: + ++ A font weight, which must be supported by the underlying typeface: + - ~thin~ + - ~ultralight~ + - ~extralight~ + - ~light~ + - ~semilight~ + - ~regular~ + - ~medium~ + - ~semibold~ + - ~bold~ (default) + - ~heavy~ + - ~extrabold~ + - ~ultrabold~ ++ A floating point as a height multiple of the default or a cons cell in + the form of =(height . FLOAT)=. -The property ~background~ applies a background color to the prompt's text. -By default, this is a subtle accented value. +By default (a ~nil~ value for this variable), all headings have a bold +typographic weight and use a desaturated text color. -The property ~intense~ makes the foreground color more prominent. If the -~background~ property is also set, it amplifies the value of the -background as well. +A ~variable-pitch~ property changes the font family of the heading to that +of the ~variable-pitch~ face (normally a proportionately spaced typeface). -The property ~gray~ changes the prompt's colors to grayscale. This -affects the foreground and, if the ~background~ property is also set, the -background. Its effect is subtle, unless it is combined with the -~intense~ property. +The symbol of a weight attribute adjusts the font of the heading +accordingly, such as ~light~, ~semibold~, etc. Valid symbols are +defined in the variable ~modus-themes-weights~. The absence of a weight +means that bold will be used by virtue of inheriting the ~bold~ face. -The property ~bold~ makes the text use a bold typographic weight. -Similarly, ~italic~ adds a slant to the font's forms (italic or oblique -forms, depending on the typeface). +[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + +A number, expressed as a floating point (e.g. 1.5), adjusts the height +of the heading to that many times the base font size. The default +height is the same as 1.0, though it need not be explicitly stated. +Instead of a floating point, an acceptable value can be in the form of a +cons cell like =(height . FLOAT)= or =(height FLOAT)=, where FLOAT is +the given number. Combinations of any of those properties are expressed as a list, like in these examples: #+begin_src emacs-lisp -(intense) -(bold intense) -(intense bold gray) -(intense background gray bold) +(semibold) +(variable-pitch semibold 1.3) +(variable-pitch semibold (height 1.3)) ; same as above +(variable-pitch semibold (height . 1.3)) ; same as above #+end_src The order in which the properties are set is not significant. @@ -1041,1134 +997,1604 @@ The order in which the properties are set is not significant. In user configuration files the form may look like this: #+begin_src emacs-lisp -(setq modus-themes-prompts '(background gray)) +(setq modus-themes-headings + '((1 . (variable-pitch 1.5)) + (2 . (1.3)) + (agenda-date . (1.3)) + (agenda-structure . (variable-pitch light 1.8)) + (t . (1.1)))) #+end_src -** Option for mode line presentation -:properties: -:alt_title: Mode line -:description: Choose among several styles, with or without borders -:custom_id: h:27943af6-d950-42d0-bc23-106e43f50a24 -:end: -#+vindex: modus-themes-mode-line - -Brief: Control the style of the mode lines. - -Symbol: ~modus-themes-mode-line~ (=choice= type, list of properties) - -Possible values, which can be expressed as a list of combinations of box -effect, color, and border visibility: - -+ Overall style: - - ~3d~ - - ~moody~ -+ ~accented~ -+ ~borderless~ -+ A natural number > 1 for extra padding or a cons cell in the form of - ~(padding . NATNUM)~. -+ A floating point to set the height of the mode line's text. It can - also be a cons cell in the form of ~(height . FLOAT)~. - -The default (a ~nil~ value or an empty list) is a two-dimensional -rectangle with a border around it. The active and the inactive mode -lines use different shades of grayscale values for the background, -foreground, border. - -The ~3d~ property applies a three-dimensional effect to the active mode -line. The inactive mode lines remain two-dimensional and are toned down -a bit, relative to the default style. - -The ~moody~ property optimizes the mode line for use with the library of -the same name (hereinafter referred to as 'Moody'). In practice, it -removes the box effect and replaces it with underline and overline -properties. It also tones down the inactive mode lines. Despite its -intended purpose, this option can also be used without the Moody library -(please consult the themes' manual on this point for more details). If -both ~3d~ and ~moody~ properties are set, the latter takes precedence. - -The ~borderless~ property removes the color of the borders. It does not -actually remove the borders, but only makes their color the same as the -background, effectively creating some padding. - -The ~accented~ property ensures that the active mode line uses a colored -background instead of the standard shade of gray. - -A positive integer (natural number or natnum) applies a padding effect -of NATNUM pixels at the boundaries of the mode lines. The default value -is 1 and does not need to be specified explicitly. The padding has no -effect when the ~moody~ property is also used, because Moody already -applies its own tweaks. To ensure that the underline is placed at the -bottom of the mode line, set ~x-underline-at-descent-line~ to non-~nil~ -(this is not needed when the ~borderless~ property is also set). For -users on Emacs 29, the ~x-use-underline-position-properties~ variable must -also be set to nil. - -The padding can also be expressed as a cons cell in the form of -=(padding . NATNUM)= or =(padding NATNUM)= where the key is constant and -NATNUM is the desired natural number. - -A floating point applies an adjusted height to the mode line's text as a -multiple of the main font size. The default rate is 1.0 and does not -need to be specified. Apart from a floating point, the height may also -be expressed as a cons cell in the form of =(height . FLOAT)= or -=(height FLOAT)= where the key is constant and the FLOAT is the desired -number. - -Combinations of any of those properties are expressed as a list, like in -these examples: +When defining the styles per heading level, it is possible to pass a +non-~nil~ value (~t~) instead of a list of properties. This will retain the +original aesthetic for that level. For example: #+begin_src emacs-lisp -(accented) -(borderless 3d) -(moody accented borderless) -#+end_src - -Same as above, using the padding and height as an example (these -all yield the same result): +(setq modus-themes-headings + '((1 . t) ; keep the default style + (2 . (semibold 1.2)) + (t . (rainbow)))) ; style for all other headings -#+begin_src emacs-lisp -(accented borderless 4 0.9) -(accented borderless (padding . 4) (height . 0.9)) -(accented borderless (padding 4) (height 0.9)) +(setq modus-themes-headings + '((1 . (variable-pitch 1.5)) + (2 . (semibold)) + (t . t))) ; default style for all other levels #+end_src -The order in which the properties are set is not significant. +Note that the text color of headings, of their background, and +overline can all be set via the overrides. It is possible to have any +color combination for any heading level (something that could not be +done in older versions of the themes). -In user configuration files the form may look like this: +[[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]. -#+begin_src emacs-lisp -(setq modus-themes-mode-line '(borderless accented)) -#+end_src - -Note that Moody does not expose any faces that the themes could style -directly. Instead it re-purposes existing ones to render its tabs and -ribbons. As such, there may be cases where the contrast ratio falls -below the 7:1 target that the themes conform with (WCAG AAA). To hedge -against this, we configure a fallback foreground for the ~moody~ property, -which will come into effect when the background of the mode line changes -to something less accessible, such as Moody ribbons (read the doc string -of ~set-face-attribute~, specifically ~:distant-foreground~). This fallback -is activated when Emacs determines that the background and foreground of -the given construct are too close to each other in terms of color -distance. In practice, users will need to experiment with the variable -~face-near-same-color-threshold~ to trigger the effect. We find that a -value of =45000= shall suffice, contrary to the default =30000=. Though for -the combinations that involve the ~accented~ and ~moody~ properties, as -mentioned above, that should be raised up to =70000=. Do not set it too -high, because it has the adverse effect of always overriding the default -colors (which have been carefully designed to be highly accessible). - -Furthermore, because Moody expects an underline and overline instead of -a box style, it is strongly advised to set ~x-underline-at-descent-line~ -to a non-~nil~ value. - -Finally, note that various packages which heavily modify the mode line, -such as =doom-modeline=, =nano-modeline=, =powerline=, =spaceline= may not look -as intended with all possible combinations of this user option. - -** Option for accented background in tab interfaces +[[#h:11297984-85ea-4678-abe9-a73aeab4676a][Make headings more or less colorful]]. + +** Option for variable-pitch font in UI elements :properties: -:alt_title: Tab style -:description: Toggle accented background for tabs -:custom_id: h:27cef8f5-dc4e-4c93-ba41-b899e650d936 +:alt_title: UI typeface +:description: Toggle the use of variable-pitch across the User Interface +:custom_id: h:16cf666c-5e65-424c-a855-7ea8a4a1fcac :end: -#+vindex: modus-themes-tabs-accented +#+vindex: modus-themes-variable-pitch-ui -Brief: Toggle accent colors for tabbed interfaces. +Brief: Toggle the use of proportionately spaced (~variable-pitch~) fonts +in the User Interface. -Symbol: ~modus-themes-tabs-accented~ (=boolean= type) +Symbol: ~modus-themes-variable-pitch-ui~ (=boolean= type) Possible values: -+ ~nil~ (default) -+ ~t~ +1. ~nil~ (default) +2. ~t~ -By default, all tab interfaces use backgrounds which are shades of gray. -When this option is set to non-~nil~, the backgrounds become colorful. +This option concerns User Interface elements that are under the direct +control of Emacs. In particular: the mode line, header line, tab bar, +and tab line. -This affects the built-in ~tab-bar-mode~ and ~tab-line-mode~, as well as the -Centaur tabs package. +The default is to use the same font as the rest of Emacs, which usually +is a monospaced family. -** Option for completion framework aesthetics +With a non-~nil~ value (~t~) apply a proportionately spaced typeface. This +is done by assigning the ~variable-pitch~ face to the relevant items. + +[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + +** Option for palette overrides :properties: -:alt_title: Completion UIs -:description: Choose among several styles for completion UIs -:custom_id: h:f1c20c02-7b34-4c35-9c65-99170efb2882 +:alt_title: Palette overrides +:description: Refashion color values and/or semantic color mappings +:custom_id: h:34c7a691-19bb-4037-8d2f-67a07edab150 :end: -#+vindex: modus-themes-completions -Brief: Set the overall style of completion framework interfaces. +This section describes palette overrides in detail. For a simpler +alternative, use the presets we provide ([[#h:b0bc811c-227e-42ec-bf67-15e1f41eb7bc][Palette override presets]]). -Symbol: ~modus-themes-completions~ (=alist= type properties) +Each Modus theme specifies a color palette that declares named color +values and semantic color mappings: -This affects Company, Corfu, Flx, Helm, Icomplete/Fido, Ido, Ivy, -Orderless, Selectrum, Vertico. The value is an alist that takes the -form of a =(KEY . PROPERTIES)= combination. =KEY= is a symbol, while -=PROPERTIES= is a list. Here is a sample, followed by a description -of the particularities: ++ Named colors consist of a symbol and a string that specifies a + hexadecimal RGB value. For example: =(blue-warmer "#354fcf")=. -#+begin_src emacs-lisp -(setq modus-themes-completions - '((matches . (extrabold background intense)) - (selection . (semibold accented intense)) - (popup . (accented)))) -#+end_src ++ The semantic color mappings associate an abstract construct with a + given named color from the palette, like =(heading-2 yellow-faint)=. + Both elements of the list are symbols, though the ~cadr~ (value) can + be a string that specifies a color, such as =(heading-2 "#354fcf")=. -The ~matches~ key refers to the highlighted characters that correspond -to the user's input. When its properties are ~nil~ or an empty list, -matching characters in the user interface will have a bold weight and -a colored foreground. The list of properties may include any of the -following symbols regardless of the order they may appear in: +#+vindex: modus-themes-common-palette-overrides +Both of those subsets can be overridden, thus refashioning the theme. +Overrides are either shared, by being stored in the user option +~modus-themes-common-palette-overrides~, or they are specific to the +theme they name. In the latter case, the naming scheme of each +palette variable is =THEME-NAME-palette-overrides=, thus yielding: -- ~background~ to add a background color; +#+vindex: modus-operandi-palette-overrides ++ ~modus-operandi-palette-overrides~ -- ~intense~ to increase the overall coloration (also amplifies - the ~background~, if present); +#+vindex: modus-operandi-deuteranopia-palette-overrides ++ ~modus-operandi-deuteranopia-palette-overrides~ -- ~underline~ to draw a line below the characters; +#+vindex: modus-operandi-tinted-palette-overrides ++ ~modus-operandi-tinted-palette-overrides~ -- ~italic~ to use a slanted font (italic or oblique forms); +#+vindex: modus-operandi-tritanopia-palette-overrides ++ ~modus-operandi-tritanopia-palette-overrides~ -- The symbol of a font weight attribute such as ~light~, ~semibold~, et - cetera. Valid symbols are defined in the ~modus-themes-weights~ - variable. The absence of a weight means that bold will be used. +#+vindex: modus-vivendi-palette-overrides ++ ~modus-vivendi-palette-overrides~ -The ~selection~ key applies to the current line or currently matched -candidate, depending on the specifics of the user interface. When its -properties are ~nil~ or an empty list, it has a subtle gray background, -a bold weight, and the base foreground value for the text. The list -of properties it accepts is as follows (order is not significant): +#+vindex: modus-vivendi-deuteranopia-palette-overrides ++ ~modus-vivendi-deuteranopia-palette-overrides~ -- ~accented~ to make the background colorful instead of gray; +#+vindex: modus-vivendi-tinted-palette-overrides ++ ~modus-vivendi-tinted-palette-overrides~ -- ~text-also~ to apply extra color to the text of the selected line; +#+vindex: modus-vivendi-tritanopia-palette-overrides ++ ~modus-vivendi-tritanopia-palette-overrides~ -- ~intense~ to increase the overall coloration; +Theme-specific overrides take precedence over the shared ones. It is +strongly advised that shared overrides do NOT alter color values, as +those will not be appropriate for both dark and light themes. Common +overrides are best limited to the semantic color mappings as those use +the color value that corresponds to the active theme (e.g. make the +cursor =blue-warmer= in all themes, whatever the value of +=blue-warmer= is in each theme). -- ~underline~ to draw a line below the characters; +The value of any overrides' variable must mirror a theme's palette. +Palette variables are named after their theme as =THEME-NAME-palette=. +For example, the ~modus-operandi-palette~ is like this: -- ~italic~ to use a slanted font (italic or oblique forms); +#+begin_src emacs-lisp +(defconst modus-operandi-palette + '( +;;; Basic values -- The symbol of a font weight attribute such as ~light~, ~semibold~, et - cetera. Valid symbols are defined in the ~modus-themes-weights~ - variable. The absence of a weight means that bold will be used. + (bg-main "#ffffff") + (bg-dim "#f0f0f0") + (fg-main "#000000") -The ~popup~ key takes the same values as ~selection~. The only -difference is that it applies specifically to user interfaces that -display an inline popup and thus have slightly different styling -requirements than the minibuffer. The two prominent packages are -=company= and =corfu=. + ;; ... -Apart from specifying each key separately, a fallback list is accepted. -This is only useful when the desired aesthetic is the same across all -keys that are not explicitly referenced. For example, this: + (red "#a60000") + (red-warmer "#972500") + (red-cooler "#a0132f") + (red-faint "#7f0000") + (red-intense "#d00000") -#+begin_src emacs-lisp -(setq modus-themes-completions - '((t . (extrabold intense)))) -#+end_src + ;; ... -Is the same as: +;;;; Mappings -#+begin_src emacs-lisp -(setq modus-themes-completions - '((matches . (extrabold intense)) - (selection . (extrabold intense)) - (popup . (extrabold intense)))) -#+end_src + ;; ... -In the case of the fallback, any property that does not apply to the -corresponding key is simply ignored (~matches~ does not have ~accented~ -and ~text-also~, while ~selection~ and ~popup~ do not have -~background~). + (cursor fg-main) + (builtin magenta-warmer) + (comment fg-dim) + (constant blue-cooler) + (docstring green-faint) + (fnname magenta) + (keyword magenta-cooler) -[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. + ;; ... + )) +#+end_src -Also refer to the documentation of the ~orderless~ package for its -intersection with ~company~ (if you choose to use those in tandem). +The ~modus-operandi-palette-overrides~ targets the entries that need +to be changed. For example, to make the main foreground color a dark +gray instead of pure black, use a shade of red for comments, and apply +a cyan hue to keywords: -** Option for mail citations -:properties: -:alt_title: Mail citations -:description: Choose among colorful, desaturated, monochrome citations -:custom_id: h:5a12765d-0ba0-4a75-ab11-e35d3bbb317d -:end: -#+vindex: modus-themes-mail-citations +#+begin_src emacs-lisp +(setq modus-operandi-palette-overrides + '((fg-main "#333333") + (comment red-faint) + (keyword cyan-cooler))) +#+end_src -Brief: Set the overall style of citations/quotes when composing -emails. +Changes take effect upon theme reload ([[#h:9001527a-4e2c-43e0-98e8-3ef72d770639][Custom reload theme]]). +Overrides are removed by setting their variable to a ~nil~ value. -Symbol: ~modus-themes-mail-citations~ (=choice= type) +The common accented foregrounds in each palette follow a predictable +naming scheme: =HUE{,-warmer,-cooler,-faint,-intense}=. =HUE= is one +of the six basic colors: red, green, blue, yellow, magenta, cyan. -Possible values: +Named colors that are meant to be used as backgrounds contain =bg= in +their name, such as =bg-red-intense=. While special purpose +foregrounds that are meant to be combined with such backgrounds, +contain =fg= in their name, such as =fg-removed= which complements +=bg-removed=. -1. ~nil~ (default) -2. ~intense~ -3. ~faint~ -4. ~monochrome~ +Named colors can be previewed, such as with the command +~modus-themes-list-colors~ ([[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Preview theme colors]]). -By default (a ~nil~ value) citations are styled with contrasting hues to -denote their depth. Colors are easy to tell apart because they -complement each other, but they otherwise are not very prominent. +For a video tutorial that users of all skill levels can approach, +watch: https://protesilaos.com/codelog/2022-12-17-modus-themes-v4-demo/. -Option ~intense~ is similar to the default in terms of using contrasting -and complementary hues, but applies more saturated colors. +* Preview theme colors +:properties: +:custom_id: h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d +:end: +#+cindex: Preview named colors or semantic color mappings -Option ~faint~ maintains the same color-based distinction between citation -levels though the colors it uses have subtle differences between them. +#+findex: modus-themes-list-colors +The command ~modus-themes-list-colors~ uses minibuffer completion to +select an item from the Modus themes and then produces a buffer with +previews of its color palette entries. The buffer has a naming scheme +that reflects the given choice, like =modus-operandi-list-colors= for +the ~modus-operandi~ theme. -Option ~monochrome~ turns all quotes into a shade of gray. +#+findex: modus-themes-list-colors-current +The command ~modus-themes-list-colors-current~ skips the minibuffer +selection process and just produces a preview for the current Modus +theme. -Whatever the value assigned to this variable, citations in emails are -controlled by typographic elements or indentation, which the themes do -not touch. +When called with a prefix argument (=C-u= with the default key +bindings), these commands will show a preview of the palette's +semantic color mappings instead of the named colors. In this context, +"named colors" are entries that associate a symbol to a string color +value, such as =(blue-warmer "#354fcf")=. Whereas "semantic color +mappings" associate a named color to a symbol, like =(string +blue-warmer)=, thus making the theme render all string constructs in +the =blue-warmer= color value ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). -** Option for fringe visibility -:properties: -:alt_title: Fringes -:description: Choose among invisible, subtle, or intense fringe styles -:custom_id: h:1983c3fc-74f6-44f3-b917-967c403bebae -:end: -#+vindex: modus-themes-fringes +#+findex: modus-themes-preview-colors +#+findex: modus-themes-preview-colors-current +Aliases for those commands are ~modus-themes-preview-colors~ and +~modus-themes-preview-colors-current~. -Brief: Control the overall coloration of the fringes. +Each row shows a foreground and background coloration using the +underlying value it references. For example a line with =#a60000= (a +shade of red) will show red text followed by a stripe with that same +color as a backdrop. -Symbol: ~modus-themes-fringes~ (=choice= type) +The name of the buffer describes the given Modus theme and what the +contents are, such as =*modus-operandi-list-colors*= for named colors +and ==*modus-operandi-list-mappings*= for the semantic color mappings. -Possible values: +* Use colors from the Modus themes palette +:PROPERTIES: +:CUSTOM_ID: h:33460ae8-984b-40fd-8baa-383cc5fc2698 +:END: -1. ~nil~ -2. ~subtle~ -3. ~intense~ +The Modus themes provide the means to access the palette of (i) the +active theme or (ii) any theme in the Modus collection. These are +useful for Do-It-Yourself customizations ([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]), +though it can also be helpful in other cases, such as to reuse a color +value in some other application. -When the value is nil, do not apply a distinct background color. +- Function :: [[#h:1cc552c1-5f5f-4a56-ae78-7b69e8512c4e][Get a single color from the palette with ~modus-themes-get-color-value~]] +- Macro :: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with ~modus-themes-with-colors~]]. -With a value of ~subtle~ use a gray background color that is -visible yet close to the main background color. +** Get a single color from the palette with ~modus-themes-get-color-value~ +:PROPERTIES: +:CUSTOM_ID: h:1cc552c1-5f5f-4a56-ae78-7b69e8512c4e +:END: -With ~intense~ use a more pronounced gray background color. +#+findex: modus-themes-get-color-value +The fuction ~modus-themes-get-color-value~ can be called from Lisp to +return the value of a color from the active Modus theme palette. It +takea a =COLOR= argument and an optional =OVERRIDES=. It also accepts +a third =THEME= argument, to get the color from the given theme. -** Option for language checkers -:properties: -:alt_title: Language checkers -:description: Control the style of language checkers/linters -:custom_id: h:4b13743a-8ebf-4d2c-a043-cceba10b1eb4 -:end: -#+vindex: modus-themes-lang-checkers +=COLOR= is a symbol that represents a named color entry in the +palette ([[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Preview theme colors]]). -Brief: Control the style of in-buffer warnings and errors produced by -spell checkers, code linters, and the like. +If the value is the name of another color entry in the palette (so a +mapping), this function recurs until it finds the underlying color +value. -Symbol: ~modus-themes-lang-checkers~ (=choice= type, list of properties) +With an optional =OVERRIDES= argument as a non-~nil~ value, it +accounts for palette overrides. Else it reads only the default palette +([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]) -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +With an optional =THEME= as a symbol among the ~modus-themes-items~ +(alias ~modus-themes-collection~), it uses the palette of that theme. +Else it uses the current Modus theme. -+ ~straight-underline~ -+ ~text-also~ -+ ~background~ -+ Overall coloration: - - ~intense~ - - ~faint~ +If =COLOR= is not present in the palette, this function returns the +~unspecified~ symbol, which is safe when used as a face attribute's +value. -The default (a ~nil~ value or an empty list) applies a color-coded -underline to the affected text, while it leaves the original foreground -intact. If the display spec of Emacs has support for it, the -underline's style is that of a wave, otherwise it is a straight line. +An example with ~modus-operandi~ to show how this function behaves +with/without overrides and when recursive mappings are introduced. -The property ~straight-underline~ ensures that the underline under the -affected text is always drawn as a straight line. +#+begin_src emacs-lisp +;; Here we show the recursion of palette mappings. In general, it is +;; better for the user to specify named colors to avoid possible +;; confusion with their configuration, though those still work as +;; expected. +(setq modus-themes-common-palette-overrides + '((cursor red) + (fg-mode-line-active cursor) + (border-mode-line-active fg-mode-line-active))) -The property ~text-also~ applies the same color of the underline to the -affected text. +;; Ignore the overrides and get the original value. +(modus-themes-get-color-value 'border-mode-line-active) +;; => "#5a5a5a" -The property ~background~ adds a color-coded background. +;; Read from the overrides and deal with any recursion to find the +;; underlying value. +(modus-themes-get-color-value 'border-mode-line-active :overrides) +;; => "#a60000" +#+end_src -The property ~intense~ amplifies the applicable colors if ~background~ -and/or ~text-also~ are set. If ~intense~ is set on its own, then it implies -~text-also~. +** Use theme colors in code with ~modus-themes-with-colors~ +:properties: +:custom_id: h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae +:end: +#+cindex: Use colors from the palette anywhere -The property ~faint~ uses nuanced colors for the underline and for the -foreground when ~text-also~ is included. If both ~faint~ and ~intense~ are -specified, the former takes precedence. +[ Note that for common cases the following is not not needed. Just rely on + the comprehensive overrides we provide ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). ] -Combinations of any of those properties can be expressed in a list, as -in those examples: +#+findex: modus-themes-with-colors +Advanced users may want to apply many colors from the palette of the +active Modus theme in their custom code. In such a case, retrieving +each value with the function ~modus-themes-get-color-value~ is +inefficient ([[#h:1cc552c1-5f5f-4a56-ae78-7b69e8512c4e][Get a single color from the palette]]). The Lisp macro +~modus-themes-with-colors~ provides the requisite functionality. It +supplies the current theme's palette to the code called from inside of +it. For example: #+begin_src emacs-lisp -(background) -(straight-underline intense) -(background text-also straight-underline) +(modus-themes-with-colors + (list blue-warmer magenta-cooler fg-added warning variable fg-heading-4)) +;; => ("#354fcf" "#531ab6" "#005000" "#884900" "#005e8b" "#721045") #+end_src -The order in which the properties are set is not significant. - -In user configuration files the form may look like this: +The above return value is for ~modus-operandi~ when that is the active +theme. Switching to another theme and evaluating this code anew will +return the relevant results for that theme (remember that since +version 4, the Modus themes consist of many items ([[#h:f0f3dbcb-602d-40cf-b918-8f929c441baf][Overview]])). The +same with ~modus-vivendi~ as the active theme: #+begin_src emacs-lisp -(setq modus-themes-lang-checkers '(text-also background)) +(modus-themes-with-colors + (list blue-warmer magenta-cooler fg-added warning variable fg-heading-4)) +;; => ("#79a8ff" "#b6a0ff" "#a0e0a0" "#fec43f" "#00d3d0" "#feacd0") #+end_src -NOTE: The placement of the straight underline, though not the wave -style, is controlled by the built-in variables ~underline-minimum-offset~, -~x-underline-at-descent-line~, ~x-use-underline-position-properties~. +The ~modus-themes-with-colors~ has access to the whole palette of the +active theme, meaning that it can instantiate both (i) named colors +like =blue-warmer= and (ii) semantic color mappings like =warning=. +We provide commands to inspect those ([[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Preview theme colors]]). -To disable fringe indicators for Flymake or Flycheck, refer to variables -~flymake-fringe-indicator-position~ and ~flycheck-indication-mode~, -respectively. +Others sections in this manual show how to use the aforementioned +macro ([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]). In practice, the use of a hook will +also be needed ([[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][DIY Use a hook at the post-load-theme phase]]). -** Option for line highlighting +* Advanced customization :properties: -:alt_title: Line highlighting -:description: Choose style of current line (hl-line-mode) -:custom_id: h:1dba1cfe-d079-4c13-a810-f768e8789177 +:custom_id: h:f4651d55-8c07-46aa-b52b-bed1e53463bb :end: -#+vindex: modus-themes-hl-line - -Brief: Control the style of the current line of ~hl-line-mode~. -Symbol: ~modus-themes-hl-line~ (=choice= type, list of properties) +Unlike the predefined customization options which follow a clear +pattern of allowing the user to quickly specify their preference, the +themes also provide a more flexible, albeit a bit more difficult, +mechanism to control things with precision ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). -The value is a list of properties, each designated by a symbol. With -a ~nil~ value, or an empty list, the style is a subtle gray background -color. +This section is of interest only to users who are prepared to maintain +their own local tweaks and who are willing to deal with any possible +incompatibilities between versioned releases of the themes. As such, +they are labeled as "do-it-yourself" or "DIY". -Possible properties are the following symbols: +** DIY Palette override presets +:PROPERTIES: +:CUSTOM_ID: h:b0bc811c-227e-42ec-bf67-15e1f41eb7bc +:END: -+ ~accented~ -+ ~intense~ -+ ~underline~ +This section shows how to refashion the themes by opting in to the +stylistic presets we provide. Those presets override the default +color mappings to amplify, tone down, or refashion the overall +coloration of the themes. -The property ~accented~ changes the background to a colored variant. +To make almost all aspects of the themes less intense, use this: -An ~underline~ property draws a line below the highlighted area. Its -color is similar to the background, so gray by default or an accent -color when ~accented~ is also set. +#+begin_src emacs-lisp +;; Always remember to reload the theme for changes to take effect! +(setq modus-themes-common-palette-overrides modus-themes-preset-overrides-faint) +#+end_src -An ~intense~ property amplifies the colors in use, which may be both the -background and the underline. +#+vindex: modus-themes-preset-overrides-faint +With ~modus-themes-preset-overrides-faint~ the grays are toned down, +gray backgrounds are removed from some contexts, and almost all accent +colors are desaturated. It makes the themes less attention-grabbing. -Combinations of any of those properties are expressed as a list, like in -these examples: +On the opposite end of the stylistic spectrum, we have this #+begin_src emacs-lisp -(intense) -(underline intense) -(accented intense underline) +;; Always remember to reload the theme for changes to take effect! +(setq modus-themes-common-palette-overrides modus-themes-preset-overrides-intense) #+end_src -The order in which the properties are set is not significant. +#+vindex: modus-themes-preset-overrides-intense +The ~modus-themes-preset-overrides-intense~ makes many background +colors accented instead of gray and increases coloration in a number +of places. Colors stand out more and are made easier to spot. -In user configuration files the form may look like this: +#+vindex: modus-themes-preset-overrides-cooler +#+vindex: modus-themes-preset-overrides-warmer +For some stylistic variation try the "cooler" and "warmer" presets: #+begin_src emacs-lisp -(setq modus-themes-hl-line '(underline accented)) +;; This: +(setq modus-themes-common-palette-overrides modus-themes-preset-overrides-cooler) + +;; Or: +(setq modus-themes-common-palette-overrides modus-themes-preset-overrides-warmer) #+end_src -Set ~x-underline-at-descent-line~ to a non-~nil~ value so that the -placement of the underline coincides with the lower boundary of the -colored background. +Note that the user is not limited to those presets. The system of +overrides we provide makes it possible to tweak the value of each +individual named color and to change how values are assigned to +semantic color mappings ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). Subsequent +sections provide examples ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). -This style affects several packages that enable ~hl-line-mode~, such as -=elfeed=, =notmuch=, and =mu4e=. +It is also possible to use those presets as a basis and, for example, +add to them code from the subsequent sections of this manual. This is +the general idea (extra space for didactic purposes): -[ Also check the =lin= package on GNU ELPA (by the author of the - modus-themes) for a stylistic enhancement to ~hl-line-mode~. ] +#+begin_src emacs-lisp +(setq modus-themes-common-palette-overrides + `( + ;; From the section "Make the mode line borderless" + (border-mode-line-active unspecified) + (border-mode-line-inactive unspecified) -** Option for line numbers -:properties: -:alt_title: Line numbers -:description: Toggle subtle style for line numbers -:custom_id: h:8c4a6230-2e43-4aa2-a631-3b7179392e09 -:end: -#+vindex: modus-themes-subtle-line-numbers + ;; From the section "Make matching parenthesis more or less intense" + (bg-paren-match bg-magenta-intense) + (underline-paren-match fg-main) -Brief: Toggle subtle line numbers. + ;; And expand the preset here. Note that the ,@ works because + ;; we use the backtick for this list, instead of a straight + ;; quote. + ,@modus-themes-preset-overrides-intense)) +#+end_src + +** DIY Stylistic variants using palette overrides +:PROPERTIES: +:CUSTOM_ID: h:df1199d8-eaba-47db-805d-6b568a577bf3 +:END: -Symbol: ~modus-themes-subtle-line-numbers~ (=boolean= type) +This section contains practical examples of overriding the palette of +the themes ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). Users can copy the code to +their init file, evaluate it, and then re-load the theme for changes +to take effect. To apply overrides at startup simply define them +before the call that loads the theme. Remember that we also provide +presets that are easier to apply ([[#h:b0bc811c-227e-42ec-bf67-15e1f41eb7bc][Palette override presets]]). -Possible value: +*** DIY Make the mode line borderless +:PROPERTIES: +:CUSTOM_ID: h:80ddba52-e188-411f-8cc0-480ebd75befe +:END: -1. ~nil~ (default) -2. ~t~ +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). To +hide the border around the active and inactive mode lines, we need to +set their color to that of the underlying background. -The default style for ~display-line-numbers-mode~ and its global variant -is to apply a subtle gray background to the line numbers. The current -line has a more pronounced background and foreground combination to -bring more attention to itself. +[[#h:e8d781be-eefc-4a81-ac4e-5ed156190df7][Make the active mode line colorful]]. -Similarly, the faces for ~display-line-numbers-major-tick~ and its -counterpart ~display-line-numbers-minor-tick~ use appropriate styles that -involve a bespoke background and foreground combination. +[[#h:5a0c58cc-f97f-429c-be08-927b9fbb0a9c][Add padding to mode line]]. -With a non-~nil~ value (~t~), line numbers have no background of their own. -Instead they retain the primary background of the theme, blending with -the rest of the buffer. Foreground values for all relevant faces are -updated to accommodate this aesthetic. +#+begin_src emacs-lisp +;; Remove the border +(setq modus-themes-common-palette-overrides + '((border-mode-line-active unspecified) + (border-mode-line-inactive unspecified))) -** Option for mouseover effects -:properties: -:alt_title: Mouse hover effects -:description: Toggle intense style for mouseover highlights -:custom_id: h:9b869620-fcc5-4b5f-9ab8-225d73b7f22f -:end: -#+vindex: modus-themes-intense-mouseovers +;; Keep the border but make it the same color as the background of the +;; mode line (thus appearing borderless). The difference with the +;; above is that this version is a bit thicker because the border are +;; still there. +(setq modus-themes-common-palette-overrides + '((border-mode-line-active bg-mode-line-active) + (border-mode-line-inactive bg-mode-line-inactive))) +#+end_src -Brief: Toggle intense mouse hover effects. +Reload the theme for changes to take effect. -Symbol: ~modus-themes-intense-mouseovers~ (=boolean= type) +*** DIY Make the active mode line colorful +:PROPERTIES: +:CUSTOM_ID: h:e8d781be-eefc-4a81-ac4e-5ed156190df7 +:END: -Possible value: +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show some snippets that apply different stylistic variants. +Of course, it is possible to use theme-specific overrides to, say, +have a blue mode line for ~modus-operandi~ and a red one for +~modus-vivendi~. -1. ~nil~ (default) -2. ~t~ +[[#h:80ddba52-e188-411f-8cc0-480ebd75befe][Make the mode line borderless]]. -By default all mouseover effects apply a highlight with a subtle colored -background. When non-~nil~, these have a more pronounced effect. +[[#h:5a0c58cc-f97f-429c-be08-927b9fbb0a9c][Add padding to mode line]]. -Note that this affects the generic ~highlight~ which, strictly speaking, -is not limited to mouse usage. +#+begin_src emacs-lisp +;; Blue background, neutral foreground, intense blue border +(setq modus-themes-common-palette-overrides + '((bg-mode-line-active bg-blue-intense) + (fg-mode-line-active fg-main) + (border-mode-line-active blue-intense))) -** Option for markup style in Org and others -:properties: -:alt_title: Markup -:description: Choose style for markup in Org and others -:custom_id: h:9d9a4e64-99ac-4018-8f66-3051b9c43fd7 -:end: -#+vindex: modus-themes-markup +;; Subtle blue background, neutral foreground, intense blue border +(setq modus-themes-common-palette-overrides + '((bg-mode-line-active bg-blue-subtle) + (fg-mode-line-active fg-main) + (border-mode-line-active blue-intense))) -Brief: Choose style of markup in Org, Markdown, and others (affects -constructs such as Org's ==verbatim== and =~code~=). +;; Sage (green/cyan) background, neutral foreground, slightly distinct green border +(setq modus-themes-common-palette-overrides + '((bg-mode-line-active bg-sage) + (fg-mode-line-active fg-main) + (border-mode-line-active bg-green-intense))) -Symbol: ~modus-themes-markup~ (=boolean= type) +;; As above, but with a purple style +(setq modus-themes-common-palette-overrides + '((bg-mode-line-active bg-lavender) + (fg-mode-line-active fg-main) + (border-mode-line-active bg-magenta-intense))) -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +;; As above, but with an earthly style +(setq modus-themes-common-palette-overrides + '((bg-mode-line-active bg-ochre) + (fg-mode-line-active fg-main) + (border-mode-line-active bg-yellow-intense))) +#+end_src -1. ~bold~ -2. ~italic~ -3. ~background~ -4. ~intense~ +Reload the theme for changes to take effect. -The ~italic~ property applies a typographic slant (italics). +*** DIY Make the tab bar more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:096658d7-a0bd-4a99-b6dc-9b20a20cda37 +:END: -The ~bold~ property applies a heavier typographic weight. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to affect the colors of the built-in ~tab-bar-mode~ +and ~tab-line-mode~. -[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. +For consistent theme-wide results, consider changing the mode line, +fringes, and line numbers. These are shown in other sections of this +manual. -The ~background~ property adds a background color. The background is a -shade of gray, unless the ~intense~ property is also set. +#+begin_src emacs-lisp +;; Make the `tab-bar-mode' mode subtle while keepings its original +;; gray aesthetic. +(setq modus-themes-common-palette-overrides + '((bg-tab-bar bg-main) + (bg-tab-current bg-active) + (bg-tab-other bg-dim))) -The ~intense~ property amplifies the existing coloration. When -~background~ is used, the background color is enhanced as well and -becomes tinted instead of being gray. +;; Like the above, but the current tab has a colorful background and +;; the inactive tabs have a slightly more noticeable gray background. +(setq modus-themes-common-palette-overrides + '((bg-tab-bar bg-main) + (bg-tab-current bg-cyan-intense) + (bg-tab-other bg-inactive))) -Combinations of any of those properties are expressed as a list, -like in these examples: +;; Make the tabs colorful, using a monochromatic pattern (e.g. shades +;; of cyan). +(setq modus-themes-common-palette-overrides + '((bg-tab-bar bg-cyan-nuanced) + (bg-tab-current bg-cyan-intense) + (bg-tab-other bg-cyan-subtle))) -#+begin_src emacs-lisp -(bold) -(bold italic) -(bold italic intense) -(bold italic intense background) +;; Like the above, but with a dichromatic pattern (cyan and magenta). +(setq modus-themes-common-palette-overrides + '((bg-tab-bar bg-cyan-nuanced) + (bg-tab-current bg-magenta-intense) + (bg-tab-other bg-cyan-subtle))) #+end_src -The order in which the properties are set is not significant. +Reload the theme for changes to take effect. -In user configuration files the form may look like this: +*** DIY Make the fringe invisible or another color +:PROPERTIES: +:CUSTOM_ID: h:c312dcac-36b6-4a1f-b1f5-ab1c9abe27b0 +:END: + +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to make the fringe invisible or how to assign to it a +different color. The "fringe" is a small area to the right and left +side of the Emacs window which shows indicators such as for truncation +or continuation lines. #+begin_src emacs-lisp -(setq modus-themes-markup '(bold italic)) -#+end_src +;; Make the fringe invisible +(setq modus-themes-common-palette-overrides + '((fringe unspecified))) -Also check the variables ~org-hide-emphasis-markers~, -~org-hide-macro-markers~. +;; Make the fringe more intense +(setq modus-themes-common-palette-overrides + '((fringe bg-active))) -** Option for parenthesis matching -:properties: -:alt_title: Matching parentheses -:description: Choose between various styles for matching delimiters/parentheses -:custom_id: h:e66a7e4d-a512-4bc7-9f86-fbbb5923bf37 -:end: -#+vindex: modus-themes-paren-match +;; Make the fringe colorful, but nuanced +(setq modus-themes-common-palette-overrides + '((fringe bg-blue-nuanced))) +#+end_src -Brief: Control the style of matching delimiters produced by -~show-paren-mode~. +Reload the theme for changes to take effect. -Symbol: ~modus-themes-paren-match~ (=choice= type, list of properties) +*** DIY Make links use subtle or no underlines +:PROPERTIES: +:CUSTOM_ID: h:6c1d1dea-5cbf-4d92-b7bb-570a7a23ffe9 +:END: -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this example, we showcase the special use of the ~unspecified~ symbol +that underline mappings can read correctly. -+ ~bold~ -+ ~intense~ -+ ~underline~ +#+begin_src emacs-lisp +;; Subtle underlines +(setq modus-themes-common-palette-overrides + '((underline-link border) + (underline-link-visited border) + (underline-link-symbolic border))) -The default (a ~nil~ value or an empty list) is a subtle background color. +;; No underlines +(setq modus-themes-common-palette-overrides + '((underline-link unspecified) + (underline-link-visited unspecified) + (underline-link-symbolic unspecified))) +#+end_src -The ~bold~ property adds a bold weight to the characters of the matching -delimiters. +Reload the theme for changes to take effect. -The ~intense~ property applies a more prominent background color to the -delimiters. +*** DIY Make prompts more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:bd75b43a-0bf1-45e7-b8b4-20944ca8b7f8 +:END: -The ~underline~ property draws a straight line under the affected text. +This section contains practical examples of overriding the palette of +the themes ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). In the following code +block we show how to add or remove color from prompts. -Combinations of any of those properties are expressed as a list, like in -these examples: +[[#h:db5a9a7c-2928-4a28-b0f0-6f2b9bd52ba1][Option for command prompt styles]]. #+begin_src emacs-lisp -(bold) -(underline intense) -(bold intense underline) +;; Keep the background unspecified (like the default), but use a faint +;; foreground color. +(setq modus-themes-common-palette-overrides + '((fg-prompt cyan-faint) + (bg-prompt unspecified))) + +;; Add a nuanced background to prompts that complements their foreground. +(setq modus-themes-common-palette-overrides + '((fg-prompt cyan) + (bg-prompt bg-cyan-nuanced))) + +;; Add a yellow background and adjust the foreground accordingly. +(setq modus-themes-common-palette-overrides + '((fg-prompt fg-main) + (bg-prompt bg-yellow-subtle))) ; try to replace "subtle" with "intense" #+end_src -The order in which the properties are set is not significant. +Reload the theme for changes to take effect. -In user configuration files the form may look like this: +*** DIY Make completion matches more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:d959f789-0517-4636-8780-18123f936f91 +:END: -#+begin_src emacs-lisp -(setq modus-themes-paren-match '(bold intense)) -#+end_src +This section contains practical examples of overriding the palette of +the themes ([[#h:34c7a691-19bb-4037-8d2f-67a07edab150][Option for palette overrides]]). Here we demonstrate how +to activate background coloration for completion matches. We show +three different degrees of intensity. + +[[#h:f1c20c02-7b34-4c35-9c65-99170efb2882][Option for completion framework aesthetics]]. + +#+begin_src emacs-lisp +;; Add a nuanced background color to completion matches, while keeping +;; their foreground intact (foregrounds do not need to be specified in +;; this case, but we do it for didactic purposes). +(setq modus-themes-common-palette-overrides + '((fg-completion-match-0 blue) + (fg-completion-match-1 magenta-warmer) + (fg-completion-match-2 cyan) + (fg-completion-match-3 red) + (bg-completion-match-0 bg-blue-nuanced) + (bg-completion-match-1 bg-magenta-nuanced) + (bg-completion-match-2 bg-cyan-nuanced) + (bg-completion-match-3 bg-red-nuanced))) + +;; Add intense background colors to completion matches and adjust the +;; foregrounds accordingly. +(setq modus-themes-common-palette-overrides + '((fg-completion-match-0 fg-main) + (fg-completion-match-1 fg-main) + (fg-completion-match-2 fg-main) + (fg-completion-match-3 fg-main) + (bg-completion-match-0 bg-blue-intense) + (bg-completion-match-1 bg-yellow-intense) + (bg-completion-match-2 bg-cyan-intense) + (bg-completion-match-3 bg-red-intense))) + +;; Like the above, but with subtle backgrounds. +(setq modus-themes-common-palette-overrides + '((fg-completion-match-0 fg-main) + (fg-completion-match-1 fg-main) + (fg-completion-match-2 fg-main) + (fg-completion-match-3 fg-main) + (bg-completion-match-0 bg-blue-subtle) + (bg-completion-match-1 bg-yellow-subtle) + (bg-completion-match-2 bg-cyan-subtle) + (bg-completion-match-3 bg-red-subtle))) +#+end_src + +Adding to the above, it is possible to, say, reduce the number of +colors to two: + +#+begin_src emacs-lisp +;; No backgrounds (like the default) and just use two colors. +(setq modus-themes-common-palette-overrides + '((fg-completion-match-0 blue) + (fg-completion-match-1 yellow) + (fg-completion-match-2 blue) + (fg-completion-match-3 yellow) + (bg-completion-match-0 unspecified) + (bg-completion-match-1 unspecified) + (bg-completion-match-2 unspecified) + (bg-completion-match-3 unspecified))) + +;; Again, a two-color style but this time with backgrounds +(setq modus-themes-common-palette-overrides + '((fg-completion-match-0 blue) + (fg-completion-match-1 yellow) + (fg-completion-match-2 blue) + (fg-completion-match-3 yellow) + (bg-completion-match-0 bg-blue-nuanced) + (bg-completion-match-1 bg-yellow-nuanced) + (bg-completion-match-2 bg-blue-nuanced) + (bg-completion-match-3 bg-yellow-nuanced))) +#+end_src + +The user can mix and match to their liking. + +Reload the theme for changes to take effect. + +*** DIY Make comments yellow and strings green +:PROPERTIES: +:CUSTOM_ID: h:26f53daa-0065-48dc-88ab-6a718d16cd95 +:END: -This customization variable affects the built-in ~show-paren-mode~ and the -=smartparens= package. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +previous versions of the themes, we provided an option for yellow-ish +comments and green-ish strings. For some users, those were still not +good enough, as the exact values were hardcoded. Here we show how to +reproduce the effect, but also how to tweak it to one's liking. -** Option for active region -:properties: -:alt_title: Active region -:description: Choose between various styles for the active region -:custom_id: h:60798063-b4ad-45ea-b9a7-ff7b5c0ab74c -:end: -#+vindex: modus-themes-region +[[#h:c8767172-bf11-4c96-81dc-e736c464fc9c][Make code syntax use the old alt-syntax style]]. -Brief: Control the style of the region. +[[#h:943063da-7b27-4ba4-9afe-f8fe77652fd1][Make use of alternative styles for code syntax]]. -Symbol: ~modus-themes-region~ (=choice= type, list of properties) +#+begin_src emacs-lisp +;; Yellow comments and green strings like older versions of the Modus +;; themes +(setq modus-themes-common-palette-overrides + '((comment yellow-cooler) + (string green-cooler))) -Possible values are expressed as a list of properties (default is ~nil~ or -an empty list). The list can include any of the following symbols: +;; Faint yellow comments and a different shade of green for strings +(setq modus-themes-common-palette-overrides + '((comment yellow-faint) + (string green-warmer))) -+ ~no-extend~ -+ ~bg-only~ -+ ~accented~ +;; Green comments and yellow strings, because now the user has the +;; freedom to do it +(setq modus-themes-common-palette-overrides + '((comment green) + (string yellow-cooler))) +#+end_src -The default (a ~nil~ value or an empty list) is a prominent gray -background that overrides all foreground colors in the area it -encompasses. Its reach extends to the edge of the window. +Reload the theme for changes to take effect. -The ~no-extend~ property limits the region to the end of the line, so that -it does not reach the edge of the window. +*** DIY Make code syntax use the old alt-syntax style +:PROPERTIES: +:CUSTOM_ID: h:c8767172-bf11-4c96-81dc-e736c464fc9c +:END: -The ~bg-only~ property makes the region's background color more subtle to -allow the underlying text to retain its foreground colors. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this section we show how to reproduce what previous versions of the +Modus themes provided as a stylistic alternative for code syntax. The +upside of using overrides for this purpose is that we can tweak the +style to our liking, but first let's start with its recreation: + +#+begin_src emacs-lisp +;; The old "alt-syntax" (before version 4.0.0 of the Modus themes) +(setq modus-themes-common-palette-overrides + '((builtin magenta) + (comment fg-dim) + (constant magenta-cooler) + (docstring magenta-faint) + (docmarkup green-faint) + (fnname magenta-warmer) + (keyword cyan) + (preprocessor cyan-cooler) + (string red-cooler) + (type magenta-cooler) + (variable blue-warmer) + (rx-construct magenta-warmer) + (rx-backslash blue-cooler))) +#+end_src + +The "alt-syntax" could optionally use green strings and yellow +comments ([[#h:26f53daa-0065-48dc-88ab-6a718d16cd95][Make comments yellow and strings green]]): + +#+begin_src emacs-lisp +;; Same as above, but with yellow comments and green strings +(setq modus-themes-common-palette-overrides + '((builtin magenta) + (comment yellow-faint) + (constant magenta-cooler) + (docstring green-faint) + (docmarkup magenta-faint) + (fnname magenta-warmer) + (keyword cyan) + (preprocessor cyan-cooler) + (string green-cooler) + (type magenta-cooler) + (variable blue-warmer) + (rx-construct magenta-warmer) + (rx-backslash blue-cooler))) +#+end_src + +The standard "alt-syntax" has red strings. As such, it is interesting +to experiment with faintly red colored comments: + +#+begin_src emacs-lisp +;; Like the old "alt-syntax" but with faint red comments +(setq modus-themes-common-palette-overrides + '((builtin magenta) + (comment red-faint) + (constant magenta-cooler) + (docstring magenta-faint) + (docmarkup green-faint) + (fnname magenta-warmer) + (keyword cyan) + (preprocessor cyan-cooler) + (string red-cooler) + (type magenta-cooler) + (variable blue-warmer) + (rx-construct magenta-warmer) + (rx-backslash blue-cooler))) +#+end_src + +The user can always mix and match styles to their liking. + +[[#h:943063da-7b27-4ba4-9afe-f8fe77652fd1][Make use of alternative styles for code syntax]]. + +Reload the theme for changes to take effect. + +*** DIY Make use of alternative styles for code syntax +:PROPERTIES: +:CUSTOM_ID: h:943063da-7b27-4ba4-9afe-f8fe77652fd1 +:END: -The ~accented~ property applies a more colorful background to the region. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). The +idea here is to change how named colors are mapped to code syntax. +Each of the following snippets give the ~modus-themes~ a different +feel while editing code. + +Note that my ~modus-themes~ and ~ef-themes~ do not use the same +palettes, so some things are different. If you copy from the latter +to the former, double-check that the entries exist in the given Modus +theme palette. + +[[#h:26f53daa-0065-48dc-88ab-6a718d16cd95][Make comments yellow and strings green]]. + +[[#h:c8767172-bf11-4c96-81dc-e736c464fc9c][Make code syntax use the old alt-syntax style]]. + +#+begin_src emacs-lisp +;; Mimic `ef-night' theme (from my `ef-themes') for code syntax +;; highlighting, while still using the Modus colors (and other +;; mappings). +(setq modus-themes-common-palette-overrides + '((builtin green-cooler) + (comment yellow-faint) + (constant magenta-cooler) + (fnname cyan-cooler) + (keyword blue-warmer) + (preprocessor red-warmer) + (docstring cyan-faint) + (string blue-cooler) + (type magenta-cooler) + (variable cyan))) + +;; Mimic `ef-summer' theme (from my `ef-themes') for code syntax +;; highlighting, while still using the Modus colors (and other +;; mappings). +(setq modus-themes-common-palette-overrides + '((builtin magenta) + (comment yellow-faint) + (constant red-cooler) + (fnname magenta-warmer) + (keyword magenta-cooler) + (preprocessor green-warmer) + (docstring cyan-faint) + (string yellow-warmer) + (type cyan-warmer) + (variable blue-warmer))) + +;; Mimic `ef-bio' theme (from my `ef-themes') for code syntax +;; highlighting, while still using the Modus colors (and other +;; mappings). +(setq modus-themes-common-palette-overrides + '((builtin green) + (comment yellow-faint) + (constant blue) + (fnname green-warmer) + (keyword green-cooler) + (preprocessor green) + (docstring green-faint) + (string magenta-cooler) + (type cyan-warmer) + (variable blue-warmer))) + +;; Mimic `ef-trio-light' theme (from my `ef-themes') for code syntax +;; highlighting, while still using the Modus colors (and other +;; mappings). +(setq modus-themes-common-palette-overrides + '((builtin magenta-cooler) + (comment yellow-faint) + (constant magenta-warmer) + (fnname blue-warmer) + (keyword magenta) + (preprocessor red-cooler) + (docstring magenta-faint) + (string green-cooler) + (type cyan-cooler) + (variable cyan-warmer))) +#+end_src + +Reload the theme for changes to take effect. + +*** DIY Make matching parenthesis more or less intense +:PROPERTIES: +:CUSTOM_ID: h:259cf8f5-48ec-4b13-8a69-5d6387094468 +:END: -Combinations of any of those properties are expressed as a list, like in -these examples: +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this code block we show how to change the background of matching +delimiters when ~show-paren-mode~ is enabled. We also demonstrate how +to enable underlines for those highlights. #+begin_src emacs-lisp -(no-extend) -(bg-only accented) -(accented bg-only no-extend) +;; Change the background to a shade of magenta +(setq modus-themes-common-palette-overrides + '((bg-paren-match bg-magenta-intense))) + +;; Enable underlines by applying a color to them +(setq modus-themes-common-palette-overrides + '((bg-paren-match bg-magenta-intense) + (underline-paren-match fg-main))) + +;; Do not use any background color and instead apply an intense red +;; foreground. +(setq modus-themes-common-palette-overrides + '((bg-paren-match unspecified) + (fg-paren-match red-intense))) #+end_src -The order in which the properties are set is not significant. +Reload the theme for changes to take effect. -In user configuration files the form may look like this: +*** DIY Make box buttons more or less gray +:PROPERTIES: +:CUSTOM_ID: h:4f6b6ca3-f5bb-4830-8312-baa232305360 +:END: + +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). By +default, the boxed buttons that appear in {{{kbd(M-x customize)}}} and +related are distinct shades of gray. The following set of overrides +removes the gray from the active buttons and amplifies it for the +inactive ones. #+begin_src emacs-lisp -(setq modus-themes-region '(bg-only no-extend)) +(setq modus-themes-common-palette-overrides + '((bg-button-active bg-main) + (fg-button-active fg-main) + (bg-button-inactive bg-inactive) + (fg-button-inactive "gray50"))) #+end_src -** Option for diff buffer looks -:properties: -:alt_title: Diffs -:description: Choose among intense, desaturated, or background-only diffs -:custom_id: h:ea7ac54f-5827-49bd-b09f-62424b3b6427 -:end: -#+vindex: modus-themes-diffs +Reload the theme for changes to take effect. -Brief: Set the overall style of diffs. +*** DIY Make TODO and DONE more or less intense +:PROPERTIES: +:CUSTOM_ID: h:b57bb50b-a863-4ea8-bb38-6de2275fa868 +:END: -Symbol: ~modus-themes-diffs~ (=choice= type) +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to affect just the =TODO= and =DONE= keywords that we +encounter in Org buffers. The idea is to make those pop out more or +to subdue them. -Possible values: +[[#h:11297984-85ea-4678-abe9-a73aeab4676a][Make headings more or less colorful]]. -1. ~nil~ (default) -2. ~desaturated~ -3. ~bg-only~ +[[#h:bb5b396f-5532-4d52-ab13-149ca24854f1][Make inline code in prose use alternative styles]]. -The default (~nil~) uses fairly intense color combinations for diffs, by -applying prominently colored backgrounds, with appropriately tinted -foregrounds. +#+begin_src emacs-lisp +;; Increase intensity +(setq modus-themes-common-palette-overrides + '((prose-done green-intense) + (prose-todo red-intense))) -Option ~desaturated~ follows the same principles as with the default -(~nil~), though it tones down all relevant colors. +;; Tone down intensity +(setq modus-themes-common-palette-overrides + '((prose-done green-faint) ; OR replace `green-faint' with `olive' + (prose-todo red-faint))) ; OR replace `red-faint' with `rust' -Option ~bg-only~ applies a background but does not override the text's -foreground. This makes it suitable for a non-~nil~ value passed to -~diff-font-lock-syntax~ (note: Magit does not support syntax highlighting -in diffs---last checked on 2021-12-02). +;; Keep TODO at its default (so no override for it), but make DONE +;; gray. +(setq modus-themes-common-palette-overrides + '((prose-done fg-dim))) +#+end_src -When the user option ~modus-themes-deuteranopia~ is non-~nil~, all diffs -will use a red/blue color-coding system instead of the standard -red/green. Other stylistic changes are made in the interest of -optimizing for such a use-case. +Reload the theme for changes to take effect. -[[#h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe][Option for red-green color deficiency or deuteranopia]]. +*** DIY Make headings more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:11297984-85ea-4678-abe9-a73aeab4676a +:END: -In versions before =2.0.0= there was an option for foreground-only diffs. -This is no longer supported at the theme level because there are cases -where the perceived contrast and overall contextuality were not good -enough although the applied colors were technically above the 7:1 -contrast threshold. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to alter the looks of headings, such as in Org mode. +Using overrides here offers far more flexibility than what we could +achieve with previous versions of the themes: the user can mix and +match styles at will. -[[#h:e2aed9eb-5e1e-45ec-bbd7-bc4faeab3236][Diffs with only the foreground]]. +[[#h:b57bb50b-a863-4ea8-bb38-6de2275fa868][Make TODO and DONE more intense]]. -[[#h:b0b31802-0216-427e-b071-1a47adcfe608][Ediff without diff color-coding]]. +#+begin_src emacs-lisp +;; Apply more colorful foreground to some headings (headings 0-8). +;; Level 0 is for Org #+title and related. +(setq modus-themes-common-palette-overrides + '((fg-heading-1 blue-warmer) + (fg-heading-2 yellow-cooler) + (fg-heading-3 cyan-cooler))) -** Option for org-mode block styles -:properties: -:alt_title: Org mode blocks -:description: Choose among plain, gray, or tinted backgrounds -:custom_id: h:b7e328c0-3034-4db7-9cdf-d5ba12081ca2 -:end: -#+vindex: modus-themes-org-blocks +;; Like the above, but with gradient colors +(setq modus-themes-common-palette-overrides + '((fg-heading-1 blue) + (fg-heading-2 cyan) + (fg-heading-3 green))) -Brief: Set the overall style of Org code blocks, quotes, and the like. +;; Add color to level 1 heading, but use the main foreground for +;; others +(setq modus-themes-common-palette-overrides + '((fg-heading-1 blue) + (fg-heading-2 fg-main) + (fg-heading-3 fg-main))) -Symbol: ~modus-themes-org-blocks~ (=choice= type) +;; Apply colorful foreground, background, and overline (headings 0-8) +(setq modus-themes-common-palette-overrides + '((fg-heading-1 blue-warmer) + (bg-heading-1 bg-blue-nuanced) + (overline-heading-1 blue))) -Possible values: +;; Apply gray scale foreground, background, and overline (headings 0-8) +(setq modus-themes-common-palette-overrides + '((fg-heading-1 fg-main) + (bg-heading-1 bg-dim) + (overline-heading-1 border))) +#+end_src -1. ~nil~ (default) -2. ~gray-background~ (value ~grayscale~ exists for backward compatibility) -3. ~tinted-background~ (value ~rainbow~ exists for backward compatibility) - -Nil (the default) means that the block has no background of its own: it -uses the one that applies to the rest of the buffer. In this case, the -delimiter lines have a gray color for their text, making them look -exactly like all other Org properties. - -Option ~gray-background~ applies a subtle gray background to the block's -contents. It also affects the begin and end lines of the block as they -get another shade of gray as their background, which differentiates them -from the contents of the block. All background colors extend to the -edge of the window, giving the area a rectangular, "blocky" -presentation. - -Option ~tinted-background~ uses a slightly colored background for the -contents of the block. The exact color will depend on the programming -language and is controlled by the variable ~org-src-block-faces~ (refer to -the theme's source code for the current association list). For this to -take effect, the Org buffer needs to be restarted with ~org-mode-restart~. -In this scenario, it may be better to inhibit the extension of the -delimiter lines' background to the edge of the window because Org does -not provide a mechanism to update their colors depending on the contents -of the block. Disable the extension of such backgrounds by setting -~org-fontify-whole-block-delimiter-line~ to nil. - -Code blocks use their major mode's colors only when the variable -~org-src-fontify-natively~ is non-~nil~. While quote/verse blocks require -setting ~org-fontify-quote-and-verse-blocks~ to a non-~nil~ value. - -[[#h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50][Update Org block delimiter fontification]]. - -Older versions of the themes provided options ~grayscale~ (or ~greyscale~) -and ~rainbow~. Those will continue to work as they are aliases for -~gray-background~ and ~tinted-background~, respectively. - -** Option for Org agenda constructs +Reload the theme for changes to take effect. + +*** DIY Make Org block colors more or less colorful :properties: -:alt_title: Org agenda -:description: Control each element in the presentation of the agenda -:custom_id: h:68f481bc-5904-4725-a3e6-d7ecfa7c3dbc +:custom_id: h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50 :end: -#+vindex: modus-themes-org-agenda -Brief: Control the style of the Org agenda. Multiple parameters are -available, each with its own options. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). Here +we show how to change the presentation of Org blocks (and other such +blocks like Markdown fenced code sections, though the exact +presentation depends on each major mode). -Symbol: ~modus-themes-org-agenda~ (=alist= type, multiple styles) +The default style of Org blocks is a subtle gray background for the +contents and for the delimiter lines (the =#+begin_= and =#+end_= +parts). The text of the delimiter lines is a subtle gray foreground +color. -This is an alist that accepts a =(key . value)= combination. Some values -are specified as a list. Here is a sample, followed by a description of -all possible combinations: +[[#h:bb5b396f-5532-4d52-ab13-149ca24854f1][Make inline code in prose use alternative styles]]. #+begin_src emacs-lisp -(setq modus-themes-org-agenda - '((header-block . (variable-pitch 1.5)) - (header-date . (grayscale workaholic bold-today 1.2)) - (event . (accented italic varied)) - (scheduled . uniform) - (habit . traffic-light))) -#+end_src +;; Make code blocks (in Org, for example) use a more colorful style +;; for their delimiter lines as well as their contents. Give this a +;; purple feel. Make the delimiter lines distinct from the contents. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-magenta-nuanced) + (bg-prose-block-delimiter bg-lavender) + (fg-prose-block-delimiter fg-main))) -A ~header-block~ key applies to elements that concern the headings which -demarcate blocks in the structure of the agenda. By default (a ~nil~ -value) those are rendered in a bold typographic weight, plus a height -that is slightly taller than the default font size. Acceptable values -come in the form of a list that can include either or both of those -properties: +;; As above, but with a more blue feel. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-blue-nuanced) + (bg-prose-block-delimiter bg-lavender) + (fg-prose-block-delimiter fg-main))) -- ~variable-pitch~ to use a proportionately spaced typeface; +;; As above, but with a green feel. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-green-nuanced) + (bg-prose-block-delimiter bg-sage) + (fg-prose-block-delimiter fg-main))) -- A number as a floating point (e.g. 1.5) to set the height of the text - to that many times the default font height. A float of 1.0 or the - symbol ~no-scale~ have the same effect of making the font the same - height as the rest of the buffer. When neither a number nor - `no-scale' are present, the default is a small increase in height (a - value of 1.15). +;; As above, but with a yellow/gold feel. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-yellow-nuanced) + (bg-prose-block-delimiter bg-ochre) + (fg-prose-block-delimiter fg-main))) - Instead of a floating point, an acceptable value can be in the form of - a cons cell like =(height . FLOAT)= or =(height FLOAT)=, where FLOAT - is the given number. - -- The symbol of a weight attribute adjusts the font of the heading - accordingly, such as ~light~, ~semibold~, etc. Valid symbols are - defined in the variable ~modus-themes-weights~. The absence of a - weight means that bold will be used by virtue of inheriting the ~bold~ - face. - -[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. - -In case both a number and ~no-scale~ are in the list, the latter takes -precedence. If two numbers are specified, the first one is applied. +;; As above, but with a slightly more red feel. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-red-nuanced) + (bg-prose-block-delimiter bg-ochre) + (fg-prose-block-delimiter fg-main))) +#+end_src -Example usage: +The previous examples differentiate the delimiter lines from the +block's contents. Though we can mimic the default aesthetic of a +uniform background, while changing the applicable colors. Here are +some nice combinations: #+begin_src emacs-lisp -(header-block . nil) -(header-block . (1.5)) -(header-block . (no-scale)) -(header-block . (variable-pitch 1.5)) -(header-block . (variable-pitch 1.5 semibold)) -#+end_src +;; Solid green style. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-green-nuanced) + (bg-prose-block-delimiter bg-green-nuanced) + (fg-prose-block-delimiter green-warmer))) -A ~header-date~ key covers date headings. Dates use only a foreground -color by default (a ~nil~ value), with weekdays and weekends having a -slight difference in hueness. The current date has an added gray -background. This key accepts a list of values that can include any of -the following properties: +;; Solid yellow style. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-yellow-nuanced) + (bg-prose-block-delimiter bg-yellow-nuanced) + (fg-prose-block-delimiter yellow-cooler))) -- ~grayscale~ to make weekdays use the main foreground color and - weekends a more subtle gray; +;; Solid cyan style. +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents bg-cyan-nuanced) + (bg-prose-block-delimiter bg-cyan-nuanced) + (fg-prose-block-delimiter cyan-cooler))) +#+end_src -- ~workaholic~ to make weekdays and weekends look the same in - terms of color; +[ Combine the above with a suitable mode line style for maximum effect + ([[#h:e8d781be-eefc-4a81-ac4e-5ed156190df7][DIY Make the active mode line colorful]]). ] -- ~bold-today~ to apply a bold typographic weight to the current - date; +Finally, the following makes code blocks have no distinct background. +The minimal styles are applied to the delimiter lines, which only use +a subtle gray foreground. This was the default for the Modus themes up +until version 4.3.0. -- ~bold-all~ to render all date headings in a bold weight; +#+begin_src emacs-lisp +;; Make code blocks more minimal, so that (i) the delimiter lines have +;; no background, (ii) the delimiter foreground is a subtle gray, and +;; (iii) the block contents have no distinct background either. This +;; was the default in versions of the Modus themes before 4.4.0 +(setq modus-themes-common-palette-overrides + '((bg-prose-block-contents unspecified) + (bg-prose-block-delimiter unspeficied) + (fg-prose-block-delimiter fg-dim))) +#+end_src -- ~underline-today~ applies an underline to the current date while - removing the background it has by default; +[[#h:8c842804-43b7-4287-b4e9-8c07d04d1f89][DIY Use colored Org source blocks per language]]. -- A number as a floating point (e.g. 1.2) to set the height of the text - to that many times the default font height. The default is the same - as the base font height (the equivalent of 1.0). Instead of a - floating point, an acceptable value can be in the form of a cons cell - like =(height . FLOAT)= or =(height FLOAT)=, where FLOAT is the given - number. +*** DIY Make Org agenda more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:a5af0452-a50f-481d-bf60-d8143f98105f +:END: -For example: +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we provide three distinct code blocks. The first adds +alternative and more varied colors to the Org agenda (and related). +The second uses faint coloration. The third makes the agenda use +various shades of blue. Mix and match at will, while also combining +these styles with what we show in the other chapters with practical +stylistic variants. #+begin_src emacs-lisp -(header-date . nil) -(header-date . (workaholic)) -(header-date . (grayscale bold-all)) -(header-date . (grayscale workaholic)) -(header-date . (grayscale workaholic bold-today)) -(header-date . (grayscale workaholic bold-today scale-heading)) -#+end_src - -An ~event~ key covers (i) headings with a plain time stamp that are -shown on the agenda, also known as events, (ii) entries imported from -the diary, and (iii) other items that derive from a symbolic expression -or sexp (phases of the moon, holidays, etc.). By default all those look -the same and have a subtle foreground color (the default is a ~nil~ value -or an empty list). This key accepts a list of properties. Those are: - -- ~accented~ applies an accent value to the event's foreground, - replacing the original gray. It makes all entries stand out more. -- ~italic~ adds a slant to the font's forms (italic or oblique forms, - depending on the typeface). -- ~varied~ differentiates between events with a plain time stamp and - entries that are generated from either the diary or a symbolic - expression. It generally puts more emphasis on events. When ~varied~ - is combined with ~accented~, it makes only events use an accent color, - while diary/sexp entries retain their original subtle foreground. - When ~varied~ is used in tandem with ~italic~, it applies a slant only - to diary and sexp entries, not events. And when ~varied~ is the sole - property passed to the ~event~ key, it has the same meaning as the - list (italic varied). The combination of ~varied~, ~accented~, - ~italic~ covers all of the aforementioned cases. +;; Make the Org agenda use alternative and varied colors. +(setq modus-themes-common-palette-overrides + '((date-common cyan) ; default value (for timestamps and more) + (date-deadline red-warmer) + (date-event magenta-warmer) + (date-holiday blue) ; for M-x calendar + (date-now yellow-warmer) + (date-scheduled magenta-cooler) + (date-weekday cyan-cooler) + (date-weekend blue-faint))) +#+end_src -For example: +An example with faint coloration: #+begin_src emacs-lisp -(event . nil) -(event . (italic)) -(event . (accented italic)) -(event . (accented italic varied)) +;; Make the Org agenda use faint colors. +(setq modus-themes-common-palette-overrides + '((date-common cyan-faint) ; for timestamps and more + (date-deadline red-faint) + (date-event fg-alt) ; default + (date-holiday magenta) ; default (for M-x calendar) + (date-now fg-main) ; default + (date-scheduled yellow-faint) + (date-weekday fg-alt) + (date-weekend fg-dim))) #+end_src -A ~scheduled~ key applies to tasks with a scheduled date. By default (a -~nil~ value), those use varying shades of yellow to denote (i) a past or -current date and (ii) a future date. Valid values are symbols: - -- ~nil~ (default); -- ~uniform~ to make all scheduled dates the same color; -- ~rainbow~ to use contrasting colors for past, present, future - scheduled dates. - -For example: +A third example that makes the agenda more blue: #+begin_src emacs-lisp -(scheduled . nil) -(scheduled . uniform) -(scheduled . rainbow) -#+end_src - -A ~habit~ key applies to the ~org-habit~ graph. All possible value are -passed as a symbol. Those are: - -- The default (~nil~) is meant to conform with the original aesthetic of - ~org-habit~. It employs all four color codes that correspond to the - org-habit states---clear, ready, alert, and overdue---while - distinguishing between their present and future variants. This - results in a total of eight colors in use: red, yellow, green, blue, - in tinted and shaded versions. They cover the full set of information - provided by the ~org-habit~ consistency graph. -- ~simplified~ is like the default except that it removes the dichotomy - between current and future variants by applying uniform color-coded - values. It applies a total of four colors: red, yellow, green, blue. - They produce a simplified consistency graph that is more legible (or - less busy) than the default. The intent is to shift focus towards the - distinction between the four states of a habit task, rather than each - state's present/future outlook. -- ~traffic-light~ further reduces the available colors to red, yellow, and - green. As in ~simplified~, present and future variants appear - uniformly, but differently from it, the ~clear~ state is rendered in a - green hue, instead of the original blue. This is meant to capture the - use-case where a habit task being too early is less important than it - being too late. The difference between ready and clear states is - attenuated by painting both of them using shades of green. This - option thus highlights the alert and overdue states. -- When ~modus-themes-deuteranopia~ is non-~nil~ the exact style of the habit - graph adapts to the needs of users with red-green color deficiency by - substituting every instance of green with blue or cyan (depending on - the specifics). - -[[#h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe][Option for red-green color deficiency or deuteranopia]]. +;; Make the Org agenda use more blue instead of yellow and red. +(setq modus-themes-common-palette-overrides + '((date-common cyan) ; default value (for timestamps and more) + (date-deadline blue-cooler) + (date-event blue-faint) + (date-holiday blue) ; for M-x calendar + (date-now blue-faint) + (date-scheduled blue) + (date-weekday fg-main) + (date-weekend fg-dim))) +#+end_src -For example: +Yet another example that also affects =DONE= and =TODO= keywords: #+begin_src emacs-lisp -(habit . nil) -(habit . simplified) -(habit . traffic-light) +;; Change dates to a set of more subtle combinations. Deadlines are a +;; shade of magenta, scheduled dates are a shade of green that +;; complements that of the deadlines, weekday headings use the main +;; foreground color while weekends are a shade of gray. The DONE +;; keyword is a faint blue-gray while TODO is yellow. +(setq modus-themes-common-palette-overrides + '((date-deadline magenta-warmer) + (date-scheduled green-cooler) + (date-weekday fg-main) + (date-event fg-dim) + (date-now blue) + (prose-done fg-alt) + (prose-todo yellow))) #+end_src -Putting it all together, the alist can look like this: +Reload the theme for changes to take effect. + +*** DIY Make inline code in prose use alternative styles +:PROPERTIES: +:CUSTOM_ID: h:bb5b396f-5532-4d52-ab13-149ca24854f1 +:END: + +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +the following code block we show how to affect constructs such as +Org's verbatim, code, and macro entries. We also provide mappings for +tables, property drawers, tags, and code block delimiters, though we +do not show every possible permutation. + +- [[#h:b57bb50b-a863-4ea8-bb38-6de2275fa868][Make TODO and DONE more or less intense]]. +- [[#h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50][DIY Make Org block colors more or less colorful]]. #+begin_src emacs-lisp -'((header-block . (1.5 variable-pitch)) - (header-date . (grayscale workaholic bold-today)) - (event . (accented varied)) - (scheduled . uniform) - (habit . traffic-light)) +;; A nuanced accented background, combined with a suitable foreground. +(setq modus-themes-common-palette-overrides + '((bg-prose-code bg-green-nuanced) + (fg-prose-code green-cooler) -;; Or else: -(setq modus-themes-org-agenda - '((header-block . (1.5 variable-pitch)) - (header-date . (grayscale workaholic bold-today)) - (event . (accented varied)) - (scheduled . uniform) - (habit . traffic-light))) -#+end_src + (bg-prose-verbatim bg-magenta-nuanced) + (fg-prose-verbatim magenta-warmer) -** Option for the headings' overall style -:properties: -:alt_title: Heading styles -:description: Choose among several styles, also per heading level -:custom_id: h:271eff19-97aa-4090-9415-a6463c2f9ae1 -:end: -#+vindex: modus-themes-headings + (bg-prose-macro bg-blue-nuanced) + (fg-prose-macro magenta-cooler))) -Brief: Heading styles with optional list of values for levels 0-8. +;; A more noticeable accented background, combined with a suitable foreground. +(setq modus-themes-common-palette-overrides + '((bg-prose-code bg-sage) + (fg-prose-code green-faint) -Symbol: ~modus-themes-headings~ (=alist= type, multiple properties) + (bg-prose-verbatim bg-ochre) + (fg-prose-verbatim red-faint) -This is an alist that accepts a =(key . list-of-values)= combination. -The key is either a number, representing the heading's level (0-8) or t, -which pertains to the fallback style. + (bg-prose-macro bg-lavender) + (fg-prose-macro blue-faint))) -Level 0 is a special heading: it is used for what counts as a document -title or equivalent, such as the =#+title= construct we find in Org -files. Levels 1-8 are regular headings. +;; Leave the backgrounds without a color and simply make the foregrounds more intense. +(setq modus-themes-common-palette-overrides + '((bg-prose-code unspecified) + (fg-prose-code green-intense) -The list of values covers symbols that refer to properties, as described -below. Here is a complete sample, followed by a presentation of all -available properties: + (bg-prose-verbatim unspecified) + (fg-prose-verbatim magenta-intense) -#+begin_src emacs-lisp -(setq modus-themes-headings - '((1 . (background overline variable-pitch 1.5)) - (2 . (overline rainbow 1.3)) - (3 . (overline 1.1)) - (t . (monochrome)))) + (bg-prose-macro unspecified) + (fg-prose-macro cyan-intense))) #+end_src -Properties: +Reload the theme for changes to take effect. -+ ~rainbow~ -+ ~overline~ -+ ~background~ -+ ~monochrome~ -+ A font weight, which must be supported by the underlying typeface: - - ~thin~ - - ~ultralight~ - - ~extralight~ - - ~light~ - - ~semilight~ - - ~regular~ - - ~medium~ - - ~semibold~ - - ~bold~ - - ~heavy~ - - ~extrabold~ - - ~ultrabold~ -+ ~no-bold~ (deprecated alias of a ~regular~ weight) -+ A floating point as a height multiple of the default or a cons cell in - the form of =(height . FLOAT)=. +*** DIY Make mail citations and headers more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:7da7a4ad-5d3a-4f11-9796-5a1abed0f0c4 +:END: -By default (a ~nil~ value for this variable), all headings have a bold -typographic weight and use a desaturated text color. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this section we show how to change the coloration of email message +headers and citations. Before we show the code, this is the anatomy +of a message: + +#+begin_example message +From: Protesilaos <info@protesilaos.com> +To: Modus-Themes Development <~protesilaos/modus-themes@lists.sr.ht> +Subject: Test subject +--- Headers above this line; message and citations below --- +This is some sample text + +> > Older quote +> Newer quote +#+end_example -A ~rainbow~ property makes the text color more saturated. +We thus have the following: + +#+begin_src emacs-lisp +;; Reduce the intensity of mail citations and headers +(setq modus-themes-common-palette-overrides + '((mail-cite-0 cyan-faint) + (mail-cite-1 yellow-faint) + (mail-cite-2 green-faint) + (mail-cite-3 red-faint) + (mail-part olive) + (mail-recipient indigo) + (mail-subject maroon) + (mail-other slate))) + +;; Make mail citations more intense; adjust the headers accordingly +(setq modus-themes-common-palette-overrides + '((mail-cite-0 blue) + (mail-cite-1 yellow) + (mail-cite-2 green) + (mail-cite-3 magenta) + (mail-part magenta-cooler) + (mail-recipient cyan) + (mail-subject red-warmer) + (mail-other cyan-cooler))) + +;; Make all citations faint and neutral; make most headers green but +;; use red for the subject lie so that it stands out +(setq modus-themes-common-palette-overrides + '((mail-cite-0 fg-dim) + (mail-cite-1 fg-alt) + (mail-cite-2 fg-dim) + (mail-cite-3 fg-alt) + (mail-part yellow-cooler) + (mail-recipient green-cooler) + (mail-subject red-cooler) + (mail-other green))) +#+end_src + +Reload the theme for changes to take effect. + +*** DIY Make the region preserve text colors, plus other styles +:PROPERTIES: +:CUSTOM_ID: h:c8605d37-66e1-42aa-986e-d7514c3af6fe +:END: -An ~overline~ property draws a line above the area of the heading. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to make the region respect the underlying text colors +or how to make the background more/less intense while combining it +with an appropriate foreground value. -A ~background~ property adds a subtle tinted color to the background of -the heading. +[[#h:a5140c9c-18b2-45db-8021-38d0b5074116][Do not extend the region background]]. -A ~monochrome~ property makes the heading the same as the base color, -which is that of the ~default~ face's foreground. When ~background~ is also -set, ~monochrome~ changes its color to gray. If both ~monochrome~ and -~rainbow~ are set, the former takes precedence. +#+begin_src emacs-lisp +;; A background with no specific foreground (use foreground of +;; underlying text) +(setq modus-themes-common-palette-overrides + '((bg-region bg-ochre) ; try to replace `bg-ochre' with `bg-lavender', `bg-sage' + (fg-region unspecified))) -A ~variable-pitch~ property changes the font family of the heading to that -of the ~variable-pitch~ face (normally a proportionately spaced typeface). +;; Subtle gray with a prominent blue foreground +(setq modus-themes-common-palette-overrides + '((bg-region bg-dim) + (fg-region blue-cooler))) -The symbol of a weight attribute adjusts the font of the heading -accordingly, such as ~light~, ~semibold~, etc. Valid symbols are -defined in the variable ~modus-themes-weights~. The absence of a weight -means that bold will be used by virtue of inheriting the ~bold~ face. -For backward compatibility, the ~no-bold~ value is accepted, though -users are encouraged to specify a ~regular~ weight instead. +;; Intense magenta background combined with the main foreground +(setq modus-themes-common-palette-overrides + '((bg-region bg-magenta-intense) + (fg-region fg-main))) +#+end_src -[[#h:2793a224-2109-4f61-a106-721c57c01375][Configure bold and italic faces]]. +Reload the theme for changes to take effect. -A number, expressed as a floating point (e.g. 1.5), adjusts the height -of the heading to that many times the base font size. The default -height is the same as 1.0, though it need not be explicitly stated. -Instead of a floating point, an acceptable value can be in the form of a -cons cell like =(height . FLOAT)= or =(height FLOAT)=, where FLOAT is -the given number. +*** DIY Make mouse highlights more or less colorful +:PROPERTIES: +:CUSTOM_ID: h:b5cab69d-d7cb-451c-8ff9-1f545ceb6caf +:END: -Combinations of any of those properties are expressed as a list, like in -these examples: +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +the following code block we show how to affect the semantic color +mapping that covers mouse hover effects and related highlights: #+begin_src emacs-lisp -(semibold) -(rainbow background) -(overline monochrome semibold 1.3) -(overline monochrome semibold (height 1.3)) ; same as above -(overline monochrome semibold (height . 1.3)) ; same as above +;; Make the background an intense yellow +(setq modus-themes-common-palette-overrides + '((bg-hover bg-yellow-intense))) + +;; Make the background subtle green +(setq modus-themes-common-palette-overrides + '((bg-hover bg-green-subtle))) #+end_src -The order in which the properties are set is not significant. +Reload the theme for changes to take effect. -In user configuration files the form may look like this: +*** DIY Make language underlines less colorful +:PROPERTIES: +:CUSTOM_ID: h:03dbd5af-6bae-475e-85a2-cec189f69598 +:END: + +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). +Here we show how to affect the color of the underlines that are used +by code linters and prose spell checkers. #+begin_src emacs-lisp -(setq modus-themes-headings - '((1 . (background overline rainbow 1.5)) - (2 . (background overline 1.3)) - (t . (overline semibold)))) +;; Make the underlines less intense +(setq modus-themes-common-palette-overrides + '((underline-err red-faint) + (underline-warning yellow-faint) + (underline-note cyan-faint))) + +;; Change the color-coding of the underlines +(setq modus-themes-common-palette-overrides + '((underline-err yellow-intense) + (underline-warning magenta-intense) + (underline-note green-intense))) #+end_src -When defining the styles per heading level, it is possible to pass a -non-~nil~ value (~t~) instead of a list of properties. This will retain the -original aesthetic for that level. For example: +Reload the theme for changes to take effect. + +*** DIY Make line numbers use alternative styles +:PROPERTIES: +:CUSTOM_ID: h:b6466f51-cb58-4007-9ebe-53a27af655c7 +:END: + +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this section we show how to affect the ~display-line-numbers-mode~. #+begin_src emacs-lisp -(setq modus-themes-headings - '((1 . t) ; keep the default style - (2 . (background overline)) - (t . (rainbow)))) ; style for all other headings +;; Make line numbers less intense +(setq modus-themes-common-palette-overrides + '((fg-line-number-inactive "gray50") + (fg-line-number-active fg-main) + (bg-line-number-inactive unspecified) + (bg-line-number-active unspecified))) -(setq modus-themes-headings - '((1 . (background overline)) - (2 . (rainbow semibold)) - (t . t))) ; default style for all other levels +;; Like the above, but use a shade of red for the current line number +(setq modus-themes-common-palette-overrides + '((fg-line-number-inactive "gray50") + (fg-line-number-active red-cooler) + (bg-line-number-inactive unspecified) + (bg-line-number-active unspecified))) + +;; Make all numbers more intense, use a more pronounce gray +;; background, and make the current line have a colored background +(setq modus-themes-common-palette-overrides + '((fg-line-number-inactive fg-main) + (fg-line-number-active fg-main) + (bg-line-number-inactive bg-inactive) + (bg-line-number-active bg-cyan-intense))) #+end_src -For Org users, the extent of the heading depends on the variable -~org-fontify-whole-heading-line~. This affects the ~overline~ and -~background~ properties. Depending on the version of Org, there may be -others, such as ~org-fontify-done-headline~. +Reload the theme for changes to take effect. -** Option for variable-pitch font in UI elements -:properties: -:alt_title: UI typeface -:description: Toggle the use of variable-pitch across the User Interface -:custom_id: h:16cf666c-5e65-424c-a855-7ea8a4a1fcac -:end: -#+vindex: modus-themes-variable-pitch-ui +*** DIY Make diffs use only a foreground +:PROPERTIES: +:CUSTOM_ID: h:b3761482-bcbf-4990-a41e-4866fb9dad15 +:END: -Brief: Toggle the use of proportionately spaced (~variable-pitch~) fonts -in the User Interface. +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this section we show how to change diff buffers (e.g. in ~magit~) to +only use color-coded text without any added background. What we +basically do is to disable the applicable backgrounds and then +intensify the foregrounds. Since the deuteranopia-optimized themes do +not use the red-green color coding, we make an extra set of +adjustments for them by overriding their palettes directly instead of +just using the "common" overrides. -Symbol: ~modus-themes-variable-pitch-ui~ (=boolean= type) +#+begin_src emacs-lisp +;; Diffs with only foreground colors. Word-wise ("refined") diffs +;; have a gray background to draw attention to themselves. +(setq modus-themes-common-palette-overrides + '((bg-added unspecified) + (bg-added-faint unspecified) + (bg-added-refine bg-inactive) + (fg-added green) + (fg-added-intense green-intense) -Possible values: + (bg-changed unspecified) + (bg-changed-faint unspecified) + (bg-changed-refine bg-inactive) + (fg-changed yellow) + (fg-changed-intense yellow-intense) -1. ~nil~ (default) -2. ~t~ + (bg-removed unspecified) + (bg-removed-faint unspecified) + (bg-removed-refine bg-inactive) + (fg-removed red) + (fg-removed-intense red-intense) -This option concerns User Interface elements that are under the direct -control of Emacs. In particular: the mode line, header line, tab bar, -and tab line. + (bg-diff-context unspecified))) -The default is to use the same font as the rest of Emacs, which usually -is a monospaced family. +;; Because deuteranopia cannot use the typical red-yellow-green +;; combination, we need to arrange for a yellow-purple-blue sequence. +;; Notice that the above covers the "common" overrides, so we do not +;; need to reproduce the whole list of them. +(setq modus-operandi-deuteranopia-palette-overrides + '((fg-added blue) + (fg-added-intense blue-intense) -With a non-~nil~ value (~t~) apply a proportionately spaced typeface. This -is done by assigning the ~variable-pitch~ face to the relevant items. + (fg-changed magenta-cooler) + (fg-changed-intense magenta-intense) -[[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. + (fg-removed yellow-warmer) + (fg-removed-intense yellow-intense))) -* Advanced customization -:properties: -:custom_id: h:f4651d55-8c07-46aa-b52b-bed1e53463bb -:end: +(setq modus-vivendi-deuteranopia-palette-overrides + '((fg-added blue) + (fg-added-intense blue-intense) -Unlike the predefined customization options which follow a clear pattern -of allowing the user to quickly specify their preference, the themes -also provide a more flexible, albeit difficult, mechanism to control -things with precision ([[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization Options]]). + (fg-changed magenta-cooler) + (fg-changed-intense magenta-intense) -This section is of interest only to users who are prepared to maintain -their own local tweaks and who are willing to deal with any possible -incompatibilities between versioned releases of the themes. As such, -they are labeled as "do-it-yourself" or "DIY". + (fg-removed yellow) + (fg-removed-intense yellow-intense))) +#+end_src + +Reload the theme for changes to take effect. + +*** DIY Make deuteranopia diffs red and blue instead of yellow and blue +:PROPERTIES: +:CUSTOM_ID: h:16389ea1-4cb6-4b18-9409-384324113541 +:END: -** More accurate colors in terminal emulators +This is one of our practical examples to override the semantic colors +of the Modus themes ([[#h:df1199d8-eaba-47db-805d-6b568a577bf3][Stylistic variants using palette overrides]]). In +this section we show how to implement a red+blue color coding for +diffs in the themes ~modus-operandi-deuteranopia~ and +~modus-vivendi-deuteranopia~. As those themes are optimized for users +with red-green color deficiency, they do not use the typical red+green +color coding for diffs, defaulting instead to yellow+blue which are +discernible. Users with deuteranomaly or, generally, those who like a +different aesthetic, can use the following to make diffs use the +red+yellow+blue color coding for removed, changed, and added lines +respectively. This is achieved by overriding the "changed" and +"removed" entries to use the colors of regular ~modus-operandi~ and +~modus-vivendi~. + +#+begin_src emacs-lisp +(setq modus-operandi-deuteranopia-palette-overrides + '((bg-changed "#ffdfa9") + (bg-changed-faint "#ffefbf") + (bg-changed-refine "#fac090") + (bg-changed-fringe "#d7c20a") + (fg-changed "#553d00") + (fg-changed-intense "#655000") + + (bg-removed "#ffd8d5") + (bg-removed-faint "#ffe9e9") + (bg-removed-refine "#f3b5af") + (bg-removed-fringe "#d84a4f") + (fg-removed "#8f1313") + (fg-removed-intense "#aa2222"))) + +(setq modus-vivendi-deuteranopia-palette-overrides + '((bg-changed "#363300") + (bg-changed-faint "#2a1f00") + (bg-changed-refine "#4a4a00") + (bg-changed-fringe "#8a7a00") + (fg-changed "#efef80") + (fg-changed-intense "#c0b05f") + + (bg-removed "#4f1119") + (bg-removed-faint "#380a0f") + (bg-removed-refine "#781a1f") + (bg-removed-fringe "#b81a1f") + (fg-removed "#ffbfbf") + (fg-removed-intense "#ff9095"))) +#+end_src + +Reload the theme for changes to take effect. + +** DIY More accurate colors in terminal emulators :PROPERTIES: :CUSTOM_ID: h:fbb5e254-afd6-4313-bb05-93b3b4f67358 :END: @@ -2197,7 +2623,7 @@ Another example that can be bound to a key: : TERM=xterm-direct uxterm -e emacsclient -nw -** Range of color with terminal emulators +** DIY Range of color with terminal emulators :PROPERTIES: :CUSTOM_ID: h:6b8211b0-d11b-4c00-9543-4685ec3b742f :END: @@ -2220,7 +2646,7 @@ the background). It thus falls back to the closest approximation, which seldom is appropriate for the purposes of the Modus themes. In such a case, the user is expected to update their terminal's color -palette such as by adapting these resources: +palette such as by adapting these resources ([[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Preview theme colors]]): #+begin_src emacs-lisp ! Theme: modus-operandi @@ -2268,29 +2694,7 @@ xterm*color14: #6ae4b9 xterm*color15: #ffffff #+end_src -** Visualize the active Modus theme's palette -:properties: -:custom_id: h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d -:end: -#+findex: modus-themes-list-colors -#+findex: modus-themes-list-colors-current -#+cindex: Preview color values - -The command ~modus-themes-list-colors~ prompts for a choice between -=modus-operandi= and =modus-vivendi= to produce a help buffer that shows a -preview of each variable in the given theme's color palette. The -command ~modus-themes-list-colors-current~ skips the prompt, using the -current Modus theme. - -Each row shows a foreground and background coloration using the -underlying value it references. For example a line with =#a60000= (a -shade of red) will show red text followed by a stripe with that same -color as a backdrop. - -The name of the buffer describes the given Modus theme. It is thus -called =*modus-operandi-list-colors*= or =*modus-vivendi-list-colors*=. - -** Per-theme customization settings +** DIY Per-theme customization settings :properties: :custom_id: h:a897b302-8e10-4a26-beab-3caaee1e1193 :end: @@ -2306,12 +2710,12 @@ other). (defun my-demo-modus-operandi () (interactive) (setq modus-themes-bold-constructs t) ; ENABLE bold - (modus-themes-load-operandi)) + (modus-themes-load-theme 'modus-operandi)) (defun my-demo-modus-vivendi () (interactive) (setq modus-themes-bold-constructs nil) ; DISABLE bold - (modus-themes-load-vivendi)) + (modus-themes-load-theme 'modus-vivendi)) (defun my-demo-modus-themes-toggle () (if (eq (car custom-enabled-themes) 'modus-operandi) @@ -2325,233 +2729,92 @@ equivalent the themes provide. For a more elaborate design, it is better to inspect the source code of ~modus-themes-toggle~ and relevant functions. -** Case-by-case face specs using the themes' palette -:properties: -:custom_id: h:1487c631-f4fe-490d-8d58-d72ffa3bd474 -:end: -#+findex: modus-themes-color -#+findex: modus-themes-color-alts -#+cindex: Extracting individual colors - -This section is about tweaking individual faces. If you plan to do -things at scale, consult the next section: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Set multiple faces]]. - -We already covered in previous sections how to toggle between the themes -and how to configure options prior to loading. We also explained that -some of the functions made available to users will fire up a hook that -can be used to pass tweaks in the post-theme-load phase. +Reload the theme for changes to take effect. -Now assume you wish to change a single face, say, the ~cursor~. And you -would like to get the standard "blue" color value of the active Modus -theme, whether it is Modus Operandi or Modus Vivendi. To do that, you -can use the ~modus-themes-color~ function. It accepts a symbol that is -associated with a color in ~modus-themes-operandi-colors~ and -~modus-themes-vivendi-colors~. Like this: - -#+begin_src emacs-lisp -(modus-themes-color 'blue) -#+end_src +** DIY Do not extend the region background +:PROPERTIES: +:CUSTOM_ID: h:a5140c9c-18b2-45db-8021-38d0b5074116 +:END: -The function always extracts the color value of the active Modus theme. +By the default, the background of the ~region~ face extends from the +end of the line to the edge of the window. To limit it to the end of +the line, we need to override the face's =:extend= attribute. Adding +this to the Emacs configuration file will suffice: #+begin_src emacs-lisp -(progn - (load-theme 'modus-operandi t) - (modus-themes-color 'blue)) ; "#0031a9" for `modus-operandi' - -(progn - (load-theme 'modus-vivendi t) - (modus-themes-color 'blue)) ; "#2fafff" for `modus-vivendi' +;; Do not extend `region' background past the end of the line. +(custom-set-faces + '(region ((t :extend nil)))) #+end_src -Do {{{kbd(C-h v)}}} on the aforementioned variables to check all the available -symbols that can be passed to this function. Or simply invoke the -command ~modus-themes-list-colors~ to produce a buffer with a preview of -each entry in the palette. - -[[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Visualize the active Modus theme's palette]]. +[[#h:c8605d37-66e1-42aa-986e-d7514c3af6fe][Make the region preserve text colors, plus other styles]]. -With that granted, let us expand the example to actually change the -~cursor~ face's background property. We employ the built-in function of -~set-face-attribute~: +** DIY Add padding to the mode line +:PROPERTIES: +:CUSTOM_ID: h:5a0c58cc-f97f-429c-be08-927b9fbb0a9c +:END: -#+begin_src emacs-lisp -(set-face-attribute 'cursor nil :background (modus-themes-color 'blue)) -#+end_src +[ Consider using the ~spacious-padding~ package from GNU ELPA (by + Protesilaos) for more than just the mode line. ] -If you evaluate this form, your cursor will become blue. But if you -change themes, such as with ~modus-themes-toggle~, your edits will be -lost, because the newly loaded theme will override the ~:background~ -attribute you had assigned to that face. +Emacs faces do not have a concept of "padding" for the space between +the text and its box boundaries. We can approximate the effect by +adding a =:box= attribute, making its border several pixels thick, and +using the mode line's background color for it. This way the thick +border will not stand out and will appear as a continuation of the +mode line. -For such changes to persist, we need to make them after loading the -theme. So we rely on ~modus-themes-after-load-theme-hook~, which gets -called from ~modus-themes-load-operandi~, ~modus-themes-load-vivendi~, as -well as the command ~modus-themes-toggle~. Here is a sample function that -tweaks two faces and then gets added to the hook: +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. #+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (set-face-attribute 'cursor nil :background (modus-themes-color 'blue)) - (set-face-attribute 'font-lock-type-face nil :foreground (modus-themes-color 'magenta-alt))) +(defun my-modus-themes-custom-faces (&rest _) + (modus-themes-with-colors + (custom-set-faces + ;; Add "padding" to the mode lines + `(mode-line ((,c :box (:line-width 10 :color ,bg-mode-line-active)))) + `(mode-line-inactive ((,c :box (:line-width 10 :color ,bg-mode-line-inactive))))))) (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) #+end_src -[[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. - -Using this principle, it is possible to override the styles of faces -without having to find color values for each case. - -Another application is to control the precise weight for bold -constructs. This is particularly useful if your typeface has several -variants such as "heavy", "extrabold", "semibold". All you have to do -is edit the ~bold~ face. For example: - -#+begin_src emacs-lisp -(set-face-attribute 'bold nil :weight 'semibold) -#+end_src - -Remember to use the custom function and hook combo we demonstrated -above. Because the themes do not hard-wire a specific weight, this -simple form is enough to change the weight of all bold constructs -throughout the interface. - -Finally, there are cases where you want to tweak colors though wish to -apply different ones to each theme, say, a blue hue for Modus Operandi -and a shade of red for Modus Vivendi. To this end, we provide -~modus-themes-color-alts~ as a convenience function to save you from the -trouble of writing separate wrappers for each theme. It still returns a -single value by querying either of ~modus-themes-operandi-colors~ and -~modus-themes-vivendi-colors~, only here you pass the two keys you want, -first for ~modus-operandi~ then ~modus-vivendi~. +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. -Take the previous example with the ~cursor~ face: +The above has the effect of removing the border around the mode lines. +In older versions of the themes, we provided the option for a padded +mode line which could also have borders around it. Those were not +real border, however, but an underline and an overline. Adjusting the +above: #+begin_src emacs-lisp -;; Blue for `modus-operandi' and red for `modus-vivendi' -(set-face-attribute 'cursor nil :background (modus-themes-color-alts 'blue 'red)) -#+end_src - -** Face specs at scale using the themes' palette -:properties: -:custom_id: h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae -:end: -#+findex: modus-themes-with-colors -#+cindex: Extracting colors en masse - -The examples here are for large scale operations. For simple, one-off -tweaks, you may prefer the approach documented in the previous section -([[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]). - -The ~modus-themes-with-colors~ macro lets you retrieve multiple color -values by employing the backquote/backtick and comma notation. The -values are stored in the alists ~modus-themes-operandi-colors~ and -~modus-themes-vivendi-colors~, while the macro always queries that of the -active Modus theme (preview the current palette with the command -~modus-themes-list-colors~). - -[[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Visualize the active Modus theme's palette]]. - -Here is an abstract example that just returns a list of color values -while ~modus-operandi~ is enabled: - -#+begin_src emacs-lisp -(modus-themes-with-colors - (list fg-main - blue-faint - magenta - magenta-alt-other - cyan-alt-other - fg-special-cold - blue-alt - magenta-faint - cyan - fg-main - green-faint - red-alt-faint - blue-alt-faint - fg-special-warm - cyan-alt - blue)) -;; => -;; ("#000000" "#002f88" "#721045" "#5317ac" -;; "#005a5f" "#093060" "#2544bb" "#752f50" -;; "#00538b" "#000000" "#104410" "#702f00" -;; "#003f78" "#5d3026" "#30517f" "#0031a9") -#+end_src - -Getting a list of colors may have its applications, though what you are -most likely interested in is how to use those variables to configure -several faces at once. To do so we can rely on the built-in -~custom-set-faces~ function, which sets face specifications for the -special ~user~ theme. That "theme" gets applied on top of regular themes -like ~modus-operandi~ and ~modus-vivendi~. - -This is how it works: - -#+begin_src emacs-lisp -(modus-themes-with-colors - (custom-set-faces - `(cursor ((,class :background ,blue))) - `(mode-line ((,class :background ,yellow-nuanced-bg - :foreground ,yellow-nuanced-fg))) - `(mode-line-inactive ((,class :background ,blue-nuanced-bg - :foreground ,blue-nuanced-fg))))) -#+end_src - -The above snippet will immediately refashion the faces it names once it -is evaluated. However, if you switch between the Modus themes, say, -from ~modus-operandi~ to ~modus-vivendi~, the colors will not get updated to -match those of the new theme. To make things work across the themes, we -need to employ the same technique we discussed in the previous section, -namely, to pass our changes at the post-theme-load phase via a hook. - -The themes provide the ~modus-themes-after-load-theme-hook~, which gets -called from ~modus-themes-load-operandi~, ~modus-themes-load-vivendi~, as -well as the command ~modus-themes-toggle~. With this knowledge, you can -wrap the macro in a function and then assign that function to the hook. -Thus: - -#+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () +(defun my-modus-themes-custom-faces (&rest _) (modus-themes-with-colors (custom-set-faces - `(cursor ((,class :background ,blue))) - `(mode-line ((,class :background ,yellow-nuanced-bg - :foreground ,yellow-nuanced-fg))) - `(mode-line-inactive ((,class :background ,blue-nuanced-bg - :foreground ,blue-nuanced-fg)))))) + ;; Add "padding" to the mode lines + `(mode-line ((,c :underline ,border-mode-line-active + :overline ,border-mode-line-active + :box (:line-width 10 :color ,bg-mode-line-active)))) + `(mode-line-inactive ((,c :underline ,border-mode-line-inactive + :overline ,border-mode-line-inactive + :box (:line-width 10 :color ,bg-mode-line-inactive))))))) + +;; ESSENTIAL to make the underline move to the bottom of the box: +(setq x-underline-at-descent-line t) (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) #+end_src -[[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. - -To discover the faces defined by all loaded libraries, you may do -{{{kbd(M-x list-faces-display)}}}. Be warned that when you ~:inherit~ a face -you are introducing an implicit dependency, so try to avoid doing so for -libraries other than the built-in {{{file(faces.el)}}} (or at least understand -that things may break if you inherit from a yet-to-be-loaded face). +The reason we no longer provide this option is because it depends on a +non-~nil~ value for ~x-underline-at-descent-line~. That variable +affects ALL underlines, including those of links. The effect is +intrusive and looks awkard in prose. -Also bear in mind that these examples are meant to work with the Modus -themes. If you are cycling between multiple themes you may encounter -unforeseen issues, such as the colors of the Modus themes being applied -to a non-Modus item. +As such, the Modus themes no longer provide that option but instead +offer this piece of documentation to make the user fully aware of the +state of affairs. -Finally, note that you can still use other functions where those make -sense. For example, the ~modus-themes-color-alts~ that was discussed in -the previous section. Adapt the above example like this: - -#+begin_src emacs-lisp -... -(modus-themes-with-colors - (custom-set-faces - `(cursor ((,class :background ,(modus-themes-color-alts 'blue 'green)))) - ...)) -#+end_src +Reload the theme for changes to take effect. -** Remap face with local value +** DIY Remap face with local value :properties: :custom_id: h:7a93cb6f-4eca-4d56-a85c-9dcd813d6b0f :end: @@ -2564,7 +2827,7 @@ activates ~hl-line-mode~, but we wish to keep it distinct from other buffers. This is where ~face-remap-add-relative~ can be applied and may be combined with ~modus-themes-with-colors~ to deliver consistent results. -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. In this example we will write a simple interactive function that adjusts the background color of the ~region~ face. This is the sample code: @@ -2572,12 +2835,12 @@ the background color of the ~region~ face. This is the sample code: #+begin_src emacs-lisp (defvar my-rainbow-region-colors (modus-themes-with-colors - `((red . ,red-subtle-bg) - (green . ,green-subtle-bg) - (yellow . ,yellow-subtle-bg) - (blue . ,blue-subtle-bg) - (magenta . ,magenta-subtle-bg) - (cyan . ,cyan-subtle-bg))) + `((red . ,bg-red-subtle) + (green . ,bg-green-subtle) + (yellow . ,bg-yellow-subtle) + (blue . ,bg-blue-subtle) + (magenta . ,bg-magenta-subtle) + (cyan . ,bg-cyan-subtle))) "Sample list of color values for `my-rainbow-region'.") (defun my-rainbow-region (color) @@ -2613,774 +2876,17 @@ Perhaps you may wish to generalize those findings in to a set of functions that also accept an arbitrary face. We shall leave the experimentation up to you. -** Cycle through arbitrary colors -:properties: -:custom_id: h:77dc4a30-b96a-4849-85a8-fee3c2995305 -:end: -#+cindex: Cycle colors - -Users may opt to customize individual faces of the themes to accommodate -their particular needs. One such case is with the color intensity of -comments, specifically the foreground of ~font-lock-comment-face~. The -Modus themes set that to a readable value, in accordance with their -accessibility objective, though users may prefer to lower the overall -contrast on an on-demand basis. - -One way to achieve this is to design a command that cycles through three -distinct levels of intensity, though the following can be adapted to any -kind of cyclic behavior, such as to switch between red, green, and blue. - -In the following example, we employ the ~modus-themes-color~ function -which reads a symbol that represents an entry in the active theme's -color palette ([[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]). -Those are stored in ~my-modus-themes-comment-colors~. - -#+begin_src emacs-lisp -(defvar my-modus-themes-comment-colors - ;; We are abusing the palette here, as those colors have their own - ;; purpose in the palette, so please ignore the semantics of their - ;; names. - '((low . bg-region) - (medium . bg-tab-inactive-alt) - (high . fg-alt)) - "Alist of levels of intensity mapped to color palette entries. -The entries are found in `modus-themes-operandi-colors' or -`modus-themes-vivendi-colors'.") - -(defvar my-modus-themes--adjust-comment-color-state nil - "The cyclic state of `my-modus-themes-adjust-comment-color'. -For internal use.") - -(defun my-modus-themes--comment-foreground (degree state) - "Set `font-lock-comment-face' foreground. -Use `my-modus-themes-comment-colors' to extract the color value -for each level of intensity. - -This is complementary to `my-modus-themes-adjust-comment-color'." - (let ((palette-colors my-modus-themes-comment-colors)) - (set-face-foreground - 'font-lock-comment-face - (modus-themes-color (alist-get degree palette-colors))) - (setq my-modus-themes--adjust-comment-color-state state) - (message "Comments are set to %s contrast" degree))) - -(defun my-modus-themes-adjust-comment-color () - "Cycle through levels of intensity for comments. -The levels are determined by `my-modus-themes-comment-colors'." - (interactive) - (pcase my-modus-themes--adjust-comment-color-state - ('nil - (my-modus-themes--comment-foreground 'low 1)) - (1 - (my-modus-themes--comment-foreground 'medium 2)) - (_ - (my-modus-themes--comment-foreground 'high nil)))) -#+end_src - -With the above, {{{kbd(M-x my-modus-themes-adjust-comment-color)}}} will cycle -through the three levels of intensity that have been specified. - -Another approach is to not read from the active theme's color palette -and instead provide explicit color values, either in hexadecimal RGB -notation (like =#123456=) or as the names that are displayed in the output -of {{{kbd(M-x list-colors-display)}}}. In this case, the alist with the -colors will have to account for the active theme, so as to set the -appropriate colors. While this introduces a bit more complexity, it -ultimately offers greater flexibility on the choice of colors for such a -niche functionality (so there is no need to abuse the palette of the -active Modus theme): - -#+begin_src emacs-lisp -(defvar my-modus-themes-comment-colors - '((light . ((low . "gray75") - (medium . "gray50") - (high . "#505050"))) ; the default for `modus-operandi' - - (dark . ((low . "gray25") - (medium . "gray50") - (high . "#a8a8a8")))) ; the default for `modus-vivendi' - "Alist of levels of intensity mapped to color values. -For such colors, consult the command `list-colors-display'. Pass -the name of a color or its hex value.") - -(defvar my-modus-themes--adjust-comment-color-state nil - "The cyclic state of `my-modus-themes-adjust-comment-color'. -For internal use.") - -(defun my-modus-themes--comment-foreground (degree state) - "Set `font-lock-comment-face' foreground. -Use `my-modus-themes-comment-colors' to extract the color value -for each level of intensity. - -This is complementary to `my-modus-themes-adjust-comment-color'." - (let* ((colors my-modus-themes-comment-colors) - (levels (pcase (car custom-enabled-themes) - ('modus-operandi (alist-get 'light colors)) - ('modus-vivendi (alist-get 'dark colors))))) - (set-face-foreground - 'font-lock-comment-face - (alist-get degree levels)) - (setq my-modus-themes--adjust-comment-color-state state) - (message "Comments are set to %s contrast" degree))) - -(defun my-modus-themes-adjust-comment-color () - "Cycle through levels of intensity for comments. -The levels are determined by `my-modus-themes-comment-colors'." - (interactive) - (pcase my-modus-themes--adjust-comment-color-state - ('nil - (my-modus-themes--comment-foreground 'low 1)) - (1 - (my-modus-themes--comment-foreground 'medium 2)) - (_ - (my-modus-themes--comment-foreground 'high nil)))) -#+end_src - -The effect of the above configurations on ~font-lock-comment-face~ is -global. To make it buffer-local, one must tweak the code to employ the -function ~face-remap-add-relative~ ([[#h:7a93cb6f-4eca-4d56-a85c-9dcd813d6b0f][Remap face with local value]]). - -So this form in ~my-modus-themes--comment-foreground~: - -#+begin_src emacs-lisp -;; example 1 -(... - (set-face-foreground - 'font-lock-comment-face - (modus-themes-color (alist-get degree palette-colors))) - ...) - -;; example 2 -(... - (set-face-foreground - 'font-lock-comment-face - (alist-get degree levels)) - ...) -#+end_src - -Must become this: - -#+begin_src emacs-lisp -;; example 1 -(... - (face-remap-add-relative - 'font-lock-comment-face - `(:foreground ,(modus-themes-color (alist-get degree palette-colors)))) - ...) - -;; example 2 -(... - (face-remap-add-relative - 'font-lock-comment-face - `(:foreground ,(alist-get degree levels))) - ...) -#+end_src - -** Override colors -:properties: -:custom_id: h:307d95dd-8dbd-4ece-a543-10ae86f155a6 -:end: -#+vindex: modus-themes-operandi-color-overrides -#+vindex: modus-themes-vivendi-color-overrides -#+cindex: Change a theme's colors - -The themes provide a mechanism for overriding their color values. This -is controlled by the variables ~modus-themes-operandi-color-overrides~ and -~modus-themes-vivendi-color-overrides~, which are alists that should -mirror a subset of the associations in ~modus-themes-operandi-colors~ and -~modus-themes-vivendi-colors~ respectively. As with all customizations, -overriding must be done before loading the affected theme. - -[[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Visualize the active Modus theme's palette]]. - -Let us approach the present topic one step at a time. Here is a -simplified excerpt of the default palette for Modus Operandi with some -basic background values that apply to buffers and the mode line -(remember to inspect the actual value to find out all the associations -that can be overridden): - -#+begin_src emacs-lisp -(defconst modus-themes-operandi-colors - '((bg-main . "#ffffff") - (bg-dim . "#f8f8f8") - (bg-alt . "#f0f0f0") - (bg-active . "#d7d7d7") - (bg-inactive . "#efefef"))) -#+end_src - -As one can tell, we bind a key to a hexadecimal RGB color value. Now -say we wish to override those specific values and have our changes -propagate to all faces that use those keys. We could write something -like this, which adds a subtle ocher tint: - -#+begin_src emacs-lisp -(setq modus-themes-operandi-color-overrides - '((bg-main . "#fefcf4") - (bg-dim . "#faf6ef") - (bg-alt . "#f7efe5") - (bg-active . "#e8dfd1") - (bg-inactive . "#f6ece5"))) -#+end_src - -Once this is evaluated, any subsequent loading of ~modus-operandi~ will -use those values instead of the defaults. No further intervention is -required. - -To reset the changes, we apply this and reload the theme: - -#+begin_src emacs-lisp -(setq modus-themes-operandi-color-overrides nil) -#+end_src - -Users who wish to leverage such a mechanism can opt to implement it -on-demand by means of a global minor mode. The following snippet covers -both themes and expands to some more associations in the palette: - -#+begin_src emacs-lisp -(define-minor-mode my-modus-themes-tinted - "Tweak some Modus themes colors." - :init-value nil - :global t - (if my-modus-themes-tinted - (setq modus-themes-operandi-color-overrides - '((bg-main . "#fefcf4") - (bg-dim . "#faf6ef") - (bg-alt . "#f7efe5") - (bg-hl-line . "#f4f0e3") - (bg-active . "#e8dfd1") - (bg-inactive . "#f6ece5") - (bg-region . "#c6bab1") - (bg-header . "#ede3e0") - (bg-tab-active . "#fdf6eb") - (bg-tab-inactive . "#c8bab8")) - modus-themes-vivendi-color-overrides - '((bg-main . "#100b17") - (bg-dim . "#161129") - (bg-alt . "#181732") - (bg-hl-line . "#191628") - (bg-active . "#282e46") - (bg-inactive . "#1a1e39") - (bg-region . "#393a53") - (bg-header . "#202037") - (bg-tab-active . "#120f18") - (bg-tab-inactive . "#3a3a5a"))) - (setq modus-themes-operandi-color-overrides nil - modus-themes-vivendi-color-overrides nil))) -#+end_src - -A more neutral style for ~modus-themes-operandi-color-overrides~ can -look like this: - -#+begin_src emacs-lisp -'((bg-main . "#f7f7f7") - (bg-dim . "#f2f2f2") - (bg-alt . "#e8e8e8") - (bg-hl-line . "#eaeaef") - (bg-active . "#e0e0e0") - (bg-inactive . "#e6e6e6") - (bg-region . "#b5b5b5") - (bg-header . "#e4e4e4") - (bg-tab-active . "#f5f5f5") - (bg-tab-inactive . "#c0c0c0")) -#+end_src - -With those in place, one can use {{{kbd(M-x my-modus-themes-tinted)}}} -and then load the Modus theme of their choice. The new palette subset -will come into effect: subtle ocher tints (or shades of gray) for Modus -Operandi and night sky blue shades for Modus Vivendi. Switching between -the two themes, such as with {{{kbd(M-x modus-themes-toggle)}}} will -also use the overrides. - -Given that this is a user-level customization, one is free to implement -whatever color values they desire, even if the possible combinations -fall below the minimum 7:1 contrast ratio that governs the design of the -themes (the WCAG AAA legibility standard). Alternatively, this can also -be done programmatically ([[#h:4589acdc-2505-41fc-9f5e-699cfc45ab00][Override color saturation]]). - -The above are expanded into a fully fledged derivative elsewhere in this -document ([[#h:736c0ff5-8c9c-4565-82cf-989e57d07d4a][Override colors completely]]). - -For manual interventions it is advised to inspect the source code of -~modus-themes-operandi-colors~ and ~modus-themes-vivendi-colors~ for the -inline commentary: it explains what the intended use of each palette -subset is. - -Furthermore, users may benefit from the ~modus-themes-contrast~ function -that we provide: [[#h:02e25930-e71a-493d-828a-8907fc80f874][test color combinations]]. It measures the contrast -ratio between two color values, so it can help in overriding the palette -(or a subset thereof) without making the end result inaccessible. - -** Override color saturation -:properties: -:custom_id: h:4589acdc-2505-41fc-9f5e-699cfc45ab00 -:end: -#+cindex: Change a theme's color saturation - -In the previous section we documented how one can override color values -manually ([[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]). Here we use a programmatic approach which -leverages the built-in ~color-saturate-name~ function to adjust the -saturation of all color values used by the active Modus theme. Our goal -is to prepare a counterpart of the active theme's palette that holds -modified color values, adjusted for a percent change in saturation. A -positive number amplifies the effect, while a negative one will move -towards a grayscale spectrum. - -We start with a function that can be either called from Lisp or invoked -interactively. In the former scenario, we pass to it the rate of change -we want. While in the latter, a minibuffer prompt asks for a number to -apply the desired effect. In either case, we intend to assign anew the -value of ~modus-themes-operandi-color-overrides~ (light theme) and the -same for ~modus-themes-vivendi-color-overrides~ (dark theme). - -#+begin_src emacs-lisp -(defun my-modus-themes-saturate (percent) - "Saturate current Modus theme palette overrides by PERCENT." - (interactive - (list (read-number "Saturation by percent: "))) - (let* ((theme (modus-themes--current-theme)) - (palette (pcase theme - ('modus-operandi modus-themes-operandi-colors) - ('modus-vivendi modus-themes-vivendi-colors) - (_ (error "No Modus theme is active")))) - (overrides (pcase theme - ('modus-operandi 'modus-themes-operandi-color-overrides) - ('modus-vivendi 'modus-themes-vivendi-color-overrides) - (_ (error "No Modus theme is active"))))) - (let (name cons colors) - (dolist (cons palette) - (setq name (color-saturate-name (cdr cons) percent)) - (setq name (format "%s" name)) - (setq cons `(,(car cons) . ,name)) - (push cons colors)) - (set overrides colors)) - (pcase theme - ('modus-operandi (modus-themes-load-operandi)) - ('modus-vivendi (modus-themes-load-vivendi))))) - -;; sample Elisp calls (or call `my-modus-themes-saturate' interactively) -(my-modus-themes-saturate 50) -(my-modus-themes-saturate -75) -#+end_src - -Using the above has an immediate effect, as it reloads the active Modus -theme. - -The =my-modus-themes-saturate= function stores new color values in the -variables ~modus-themes-operandi-color-overrides~ and -~modus-themes-vivendi-color-overrides~, meaning that it undoes changes -implemented by the user on individual colors. To have both automatic -saturation adjustment across the board and retain per-case edits to the -palette, some tweaks to the above function are required. For example: - -#+begin_src emacs-lisp -(defvar my-modus-themes-vivendi-extra-color-overrides - '((fg-main . "#ead0c0") - (bg-main . "#050515")) - "My bespoke colors for `modus-vivendi'.") - -(defvar my-modus-themes-operandi-extra-color-overrides - '((fg-main . "#1a1a1a") - (bg-main . "#fefcf4")) - "My bespoke colors for `modus-operandi'.") - -(defun my-modus-themes-saturate (percent) - "Saturate current Modus theme palette overrides by PERCENT. -Preserve the color values stored in -`my-modus-themes-operandi-extra-color-overrides', -`my-modus-themes-vivendi-extra-color-overrides'." - (interactive - (list (read-number "Saturation by percent: "))) - (let* ((theme (modus-themes--current-theme)) - (palette (pcase theme - ('modus-operandi modus-themes-operandi-colors) - ('modus-vivendi modus-themes-vivendi-colors) - (_ (error "No Modus theme is active")))) - (overrides (pcase theme - ('modus-operandi 'modus-themes-operandi-color-overrides) - ('modus-vivendi 'modus-themes-vivendi-color-overrides) - (_ (error "No Modus theme is active")))) - (extra-overrides (pcase theme - ('modus-operandi my-modus-themes-operandi-extra-color-overrides) - ('modus-vivendi my-modus-themes-vivendi-extra-color-overrides) - (_ (error "No Modus theme is active"))))) - (let (name cons colors) - (dolist (cons palette) - (setq name (color-saturate-name (cdr cons) percent)) - (setq name (format "%s" name)) - (setq cons `(,(car cons) . ,name)) - (push cons colors)) - (set overrides (append extra-overrides colors))) - (pcase theme - ('modus-operandi (modus-themes-load-operandi)) - ('modus-vivendi (modus-themes-load-vivendi))))) -#+end_src - -To disable the effect, one must reset the aforementioned variables of -the themes to ~nil~. Or specify a command for it, such as by taking -inspiration from the ~modus-themes-toggle~ we already provide: - -#+begin_src emacs-lisp -(defun my-modus-themes-revert-overrides () - "Reset palette overrides and reload active Modus theme." - (interactive) - (setq modus-themes-operandi-color-overrides nil - modus-themes-vivendi-color-overrides nil) - (pcase (modus-themes--current-theme) - ('modus-operandi (modus-themes-load-operandi)) - ('modus-vivendi (modus-themes-load-vivendi)))) -#+end_src +Reload the theme for changes to take effect. -** Override colors through blending -:properties: -:custom_id: h:80c326bf-fe32-47b2-8c59-58022256fd6e -:end: -#+cindex: Change theme colors through blending - -This is yet another method of overriding color values. - -[[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]. - -[[#h:4589acdc-2505-41fc-9f5e-699cfc45ab00][Override color saturation]]. - -Building on ideas and concepts from the previous sections, this method -blends the entire palette at once with the chosen colors. The function -~my-modus-themes-interpolate~ blends two colors, taking a value from the -themes and mixing it with a user-defined color to arrive at a midpoint. -This scales to all background and foreground colors with the help of the -~my-modus-themes-tint-palette~ function. - -#+begin_src emacs-lisp -(setq my-modus-operandi-bg-blend "#fbf1c7" - my-modus-operandi-fg-blend "#3a6084" - my-modus-vivendi-bg-blend "#3a4042" - my-modus-vivendi-fg-blend "#d7b765") - -;; Adapted from the `kurecolor-interpolate' function of kurecolor.el -(defun my-modus-themes-interpolate (color1 color2) - (cl-destructuring-bind (r g b) - (mapcar #'(lambda (n) (* (/ n 2) 255.0)) - (cl-mapcar '+ (color-name-to-rgb color1) (color-name-to-rgb color2))) - (format "#%02X%02X%02X" r g b))) - -(defun my-modus-themes-tint-palette (palette bg-blend fg-blend) - "Modify Modus PALETTE programmatically and return a new palette. -Blend background colors with BG-BLEND and foreground colors with FG-BLEND." - (let (name cons colors) - (dolist (cons palette) - (let ((blend (if (string-match "bg" (symbol-name (car cons))) - bg-blend - fg-blend))) - (setq name (my-modus-themes-interpolate (cdr cons) blend))) - (setq name (format "%s" name)) - (setq cons `(,(car cons) . ,name)) - (push cons colors)) - colors)) - -(define-minor-mode modus-themes-tinted-mode - "Tweak some Modus themes colors." - :init-value nil - :global t - (if modus-themes-tinted-mode - (setq modus-themes-operandi-color-overrides - (my-modus-themes-tint-palette modus-themes-operandi-colors - my-modus-operandi-bg-blend - my-modus-operandi-fg-blend) - modus-themes-vivendi-color-overrides - (my-modus-themes-tint-palette modus-themes-vivendi-colors - my-modus-vivendi-bg-blend - my-modus-vivendi-fg-blend)) - (setq modus-themes-operandi-color-overrides nil - modus-themes-vivendi-color-overrides nil))) - -(modus-themes-tinted-mode 1) -#+end_src - -** Override colors completely -:PROPERTIES: -:CUSTOM_ID: h:736c0ff5-8c9c-4565-82cf-989e57d07d4a -:END: - -Based on the ideas we have already covered in these sections, the -following code block provides a complete, bespoke pair of color palettes -which override the defaults. They are implemented as a minor mode, as -explained before ([[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]). We call them "Summertime" for -convenience. - -#+begin_src emacs-lisp -;; Read the relevant blog post: -;; <https://protesilaos.com/codelog/2022-07-26-modus-themes-color-override-demo/> -(define-minor-mode modus-themes-summertime - "Refashion the Modus themes by overriding their colors. - -This is a complete technology demonstration to show how to -manually override the colors of the Modus themes. I have taken -good care of those overrides to make them work as a fully fledged -color scheme that is compatible with all user options of the -Modus themes. - -These overrides are usable by those who (i) like something more -fancy than the comparatively austere looks of the Modus themes, -and (ii) can cope with a lower contrast ratio. - -The overrides are set up as a minor mode, so that the user can -activate the effect on demand. Those who want to load the -overrides at all times can either add them directly to their -configuration or enable `modus-themes-summertime' BEFORE loading -either of the Modus themes (if the overrides are evaluated after -the theme, the theme must be reloaded). - -Remember that all changes to theme-related variables require a -reload of the theme to take effect (the Modus themes have lots of -user options, apart from those overrides). - -The `modus-themes-summertime' IS NOT an official extension to the -Modus themes and DOES NOT comply with its lofty accessibility -standards. It is included in the official manual as guidance for -those who want to make use of the color overriding facility we -provide." - :init-value nil - :global t - (if modus-themes-summertime - (setq modus-themes-operandi-color-overrides - '((bg-main . "#fff0f2") - (bg-dim . "#fbe6ef") - (bg-alt . "#f5dae6") - (bg-hl-line . "#fad8e3") - (bg-active . "#efcadf") - (bg-inactive . "#f3ddef") - (bg-active-accent . "#ffbbef") - (bg-region . "#dfc5d1") - (bg-region-accent . "#efbfef") - (bg-region-accent-subtle . "#ffd6ef") - (bg-header . "#edd3e0") - (bg-tab-active . "#ffeff2") - (bg-tab-inactive . "#f8d3ef") - (bg-tab-inactive-accent . "#ffd9f5") - (bg-tab-inactive-alt . "#e5c0d5") - (bg-tab-inactive-alt-accent . "#f3cce0") - (fg-main . "#543f78") - (fg-dim . "#5f476f") - (fg-alt . "#7f6f99") - (fg-unfocused . "#8f6f9f") - (fg-active . "#563068") - (fg-inactive . "#8a5698") - (fg-docstring . "#5f5fa7") - (fg-comment-yellow . "#a9534f") - (fg-escape-char-construct . "#8b207f") - (fg-escape-char-backslash . "#a06d00") - (bg-special-cold . "#d3e0f4") - (bg-special-faint-cold . "#e0efff") - (bg-special-mild . "#c4ede0") - (bg-special-faint-mild . "#e0f0ea") - (bg-special-warm . "#efd0c4") - (bg-special-faint-warm . "#ffe4da") - (bg-special-calm . "#f0d3ea") - (bg-special-faint-calm . "#fadff9") - (fg-special-cold . "#405fb8") - (fg-special-mild . "#407f74") - (fg-special-warm . "#9d6f4f") - (fg-special-calm . "#af509f") - (bg-completion . "#ffc5e5") - (bg-completion-subtle . "#f7cfef") - (red . "#ed2f44") - (red-alt . "#e0403d") - (red-alt-other . "#e04059") - (red-faint . "#ed4f44") - (red-alt-faint . "#e0603d") - (red-alt-other-faint . "#e06059") - (green . "#217a3c") - (green-alt . "#417a1c") - (green-alt-other . "#006f3c") - (green-faint . "#318a4c") - (green-alt-faint . "#518a2c") - (green-alt-other-faint . "#20885c") - (yellow . "#b06202") - (yellow-alt . "#a95642") - (yellow-alt-other . "#a06f42") - (yellow-faint . "#b07232") - (yellow-alt-faint . "#a96642") - (yellow-alt-other-faint . "#a08042") - (blue . "#275ccf") - (blue-alt . "#475cc0") - (blue-alt-other . "#3340ef") - (blue-faint . "#476ce0") - (blue-alt-faint . "#575ccf") - (blue-alt-other-faint . "#3f60d7") - (magenta . "#bf317f") - (magenta-alt . "#d033c0") - (magenta-alt-other . "#844fe4") - (magenta-faint . "#bf517f") - (magenta-alt-faint . "#d053c0") - (magenta-alt-other-faint . "#846fe4") - (cyan . "#007a9f") - (cyan-alt . "#3f709f") - (cyan-alt-other . "#107f7f") - (cyan-faint . "#108aaf") - (cyan-alt-faint . "#3f80af") - (cyan-alt-other-faint . "#3088af") - (red-active . "#cd2f44") - (green-active . "#116a6c") - (yellow-active . "#993602") - (blue-active . "#475ccf") - (magenta-active . "#7f2ccf") - (cyan-active . "#007a8f") - (red-nuanced-bg . "#ffdbd0") - (red-nuanced-fg . "#ed6f74") - (green-nuanced-bg . "#dcf0dd") - (green-nuanced-fg . "#3f9a4c") - (yellow-nuanced-bg . "#fff3aa") - (yellow-nuanced-fg . "#b47232") - (blue-nuanced-bg . "#e3e3ff") - (blue-nuanced-fg . "#201f6f") - (magenta-nuanced-bg . "#fdd0ff") - (magenta-nuanced-fg . "#c0527f") - (cyan-nuanced-bg . "#dbefff") - (cyan-nuanced-fg . "#0f3f60") - (bg-diff-heading . "#b7cfe0") - (fg-diff-heading . "#041645") - (bg-diff-added . "#d6f0d6") - (fg-diff-added . "#004520") - (bg-diff-changed . "#fcefcf") - (fg-diff-changed . "#524200") - (bg-diff-removed . "#ffe0ef") - (fg-diff-removed . "#891626") - (bg-diff-refine-added . "#84cfa4") - (fg-diff-refine-added . "#002a00") - (bg-diff-refine-changed . "#cccf8f") - (fg-diff-refine-changed . "#302010") - (bg-diff-refine-removed . "#da92b0") - (fg-diff-refine-removed . "#500010") - (bg-diff-focus-added . "#a6e5c6") - (fg-diff-focus-added . "#002c00") - (bg-diff-focus-changed . "#ecdfbf") - (fg-diff-focus-changed . "#392900") - (bg-diff-focus-removed . "#efbbcf") - (fg-diff-focus-removed . "#5a0010")) - modus-themes-vivendi-color-overrides - '((bg-main . "#25152a") - (bg-dim . "#2a1930") - (bg-alt . "#382443") - (bg-hl-line . "#332650") - (bg-active . "#463358") - (bg-inactive . "#2d1f3a") - (bg-active-accent . "#50308f") - (bg-region . "#5d4a67") - (bg-region-accent . "#60509f") - (bg-region-accent-subtle . "#3f285f") - (bg-header . "#3a2543") - (bg-tab-active . "#26162f") - (bg-tab-inactive . "#362647") - (bg-tab-inactive-accent . "#36265a") - (bg-tab-inactive-alt . "#3e2f5a") - (bg-tab-inactive-alt-accent . "#3e2f6f") - (fg-main . "#debfe0") - (fg-dim . "#d0b0da") - (fg-alt . "#ae85af") - (fg-unfocused . "#8e7f9f") - (fg-active . "#cfbfef") - (fg-inactive . "#b0a0c0") - (fg-docstring . "#c8d9f7") - (fg-comment-yellow . "#cf9a70") - (fg-escape-char-construct . "#ff75aa") - (fg-escape-char-backslash . "#dbab40") - (bg-special-cold . "#2a3f58") - (bg-special-faint-cold . "#1e283f") - (bg-special-mild . "#0f3f31") - (bg-special-faint-mild . "#0f281f") - (bg-special-warm . "#44331f") - (bg-special-faint-warm . "#372213") - (bg-special-calm . "#4a314f") - (bg-special-faint-calm . "#3a223f") - (fg-special-cold . "#c0b0ff") - (fg-special-mild . "#bfe0cf") - (fg-special-warm . "#edc0a6") - (fg-special-calm . "#ff9fdf") - (bg-completion . "#502d70") - (bg-completion-subtle . "#451d65") - (red . "#ff5f6f") - (red-alt . "#ff8f6d") - (red-alt-other . "#ff6f9d") - (red-faint . "#ffa0a0") - (red-alt-faint . "#f5aa80") - (red-alt-other-faint . "#ff9fbf") - (green . "#51ca5c") - (green-alt . "#71ca3c") - (green-alt-other . "#51ca9c") - (green-faint . "#78bf78") - (green-alt-faint . "#99b56f") - (green-alt-other-faint . "#88bf99") - (yellow . "#f0b262") - (yellow-alt . "#f0e242") - (yellow-alt-other . "#d0a272") - (yellow-faint . "#d2b580") - (yellow-alt-faint . "#cabf77") - (yellow-alt-other-faint . "#d0ba95") - (blue . "#778cff") - (blue-alt . "#8f90ff") - (blue-alt-other . "#8380ff") - (blue-faint . "#82b0ec") - (blue-alt-faint . "#a0acef") - (blue-alt-other-faint . "#80b2f0") - (magenta . "#ff70cf") - (magenta-alt . "#ff77f0") - (magenta-alt-other . "#ca7fff") - (magenta-faint . "#e0b2d6") - (magenta-alt-faint . "#ef9fe4") - (magenta-alt-other-faint . "#cfa6ff") - (cyan . "#30cacf") - (cyan-alt . "#60caff") - (cyan-alt-other . "#40b79f") - (cyan-faint . "#90c4ed") - (cyan-alt-faint . "#a0bfdf") - (cyan-alt-other-faint . "#a4d0bb") - (red-active . "#ff6059") - (green-active . "#64dc64") - (yellow-active . "#ffac80") - (blue-active . "#4fafff") - (magenta-active . "#cf88ff") - (cyan-active . "#50d3d0") - (red-nuanced-bg . "#440a1f") - (red-nuanced-fg . "#ffcccc") - (green-nuanced-bg . "#002904") - (green-nuanced-fg . "#b8e2b8") - (yellow-nuanced-bg . "#422000") - (yellow-nuanced-fg . "#dfdfb0") - (blue-nuanced-bg . "#1f1f5f") - (blue-nuanced-fg . "#bfd9ff") - (magenta-nuanced-bg . "#431641") - (magenta-nuanced-fg . "#e5cfef") - (cyan-nuanced-bg . "#042f49") - (cyan-nuanced-fg . "#a8e5e5") - (bg-diff-heading . "#304466") - (fg-diff-heading . "#dae7ff") - (bg-diff-added . "#0a383a") - (fg-diff-added . "#94ba94") - (bg-diff-changed . "#2a2000") - (fg-diff-changed . "#b0ba9f") - (bg-diff-removed . "#50163f") - (fg-diff-removed . "#c6adaa") - (bg-diff-refine-added . "#006a46") - (fg-diff-refine-added . "#e0f6e0") - (bg-diff-refine-changed . "#585800") - (fg-diff-refine-changed . "#ffffcc") - (bg-diff-refine-removed . "#952838") - (fg-diff-refine-removed . "#ffd9eb") - (bg-diff-focus-added . "#1d4c3f") - (fg-diff-focus-added . "#b4dfb4") - (bg-diff-focus-changed . "#424200") - (fg-diff-focus-changed . "#d0daaf") - (bg-diff-focus-removed . "#6f0f39") - (fg-diff-focus-removed . "#eebdba"))) - (setq modus-themes-operandi-color-overrides nil - modus-themes-vivendi-color-overrides nil))) -#+end_src - -** Font configurations for Org and others +** DIY Font configurations for Org and others :properties: :custom_id: h:defcf4fc-8fa8-4c29-b12e-7119582cc929 :end: #+cindex: Font configurations +[ Consider using the ~fontaine~ package from GNU ELPA (by Protesilaos) + for all font-related configurations. ] + The themes are designed to optionally cope well with mixed font configurations. This mostly concerns ~org-mode~ and ~markdown-mode~, though expect to find it elsewhere like in ~Info-mode~. @@ -3400,9 +2906,6 @@ the ~variable-pitch~ (proportional spacing) and ~fixed-pitch~ (monospaced) faces respectively. It may also be convenient to set your main typeface by configuring the ~default~ face the same way. -[ The =fontaine= package on GNU ELPA (by the author of the modus-themes) - is designed to handle this case. ] - Put something like this in your initialization file (also consider reading the doc string of ~set-face-attribute~): @@ -3444,12 +2947,15 @@ absolute height). [[#h:e6c5451f-6763-4be7-8fdb-b4706a422a4c][Note for EWW and Elfeed fonts]]. -** Configure bold and italic faces +** DIY Configure bold and italic faces :properties: :custom_id: h:2793a224-2109-4f61-a106-721c57c01375 :end: #+cindex: Bold and italic fonts +[ Consider using the ~fontaine~ package from GNU ELPA (by Protesilaos) + for all font-related configurations. ] + The Modus themes do not hardcode a ~:weight~ or ~:slant~ attribute in the thousands of faces they cover. Instead, they configure the generic faces called ~bold~ and ~italic~ to use the appropriate styles and then @@ -3503,12 +3009,12 @@ To reset the font family, one can use this: #+end_src To ensure that the effects persist after switching between the Modus -themes (such as with {{{kbd(M-x modus-themes-toggle)}}}), the user needs to -write their configurations to a function and pass it to the -~modus-themes-after-load-theme-hook~. This is necessary because themes -set the styles of faces upon activation, overriding prior values where -conflicts occur between the previous and the current states (otherwise -changing themes would not be possible). +themes (such as with {{{kbd(M-x modus-themes-toggle)}}}), the user +needs to write their configurations to a function and pass it to the +~modus-themes-after-load-theme-hook~ ([[#h:3f3c3728-1b34-437d-9d0c-b110f5b161a9][Enable and load]]). This is +necessary because themes set the styles of faces upon activation, +overriding prior values where conflicts occur between the previous and +the current states (otherwise changing themes would not be possible). [[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]. @@ -3521,14 +3027,14 @@ of the themes, which can make it easier to redefine faces in bulk). #+begin_src emacs-lisp ;; our generic function -(defun my-modes-themes-bold-italic-faces () +(defun my-modes-themes-bold-italic-faces (&rest _) (set-face-attribute 'default nil :family "Source Code Pro" :height 110) (set-face-attribute 'bold nil :weight 'semibold)) ;; or use this if you configure a lot of face and attributes and ;; especially if you plan to use `modus-themes-with-colors', as shown ;; elsewhere in the manual -(defun my-modes-themes-bold-italic-faces () +(defun my-modes-themes-bold-italic-faces (&rest _) (custom-set-faces '(default ((t :family "Source Code Pro" :height 110))) '(bold ((t :weight semibold))))) @@ -3537,9 +3043,13 @@ of the themes, which can make it easier to redefine faces in bulk). (add-hook 'modus-themes-after-load-theme-hook #'my-modes-themes-bold-italic-faces) #+end_src -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. -** Custom Org todo keyword and priority faces +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + +Reload the theme for changes to take effect. + +** DIY Custom Org todo keyword and priority faces :properties: :custom_id: h:89f0678d-c5c3-4a57-a526-668b2bb2d7ad :end: @@ -3571,20 +3081,20 @@ have something like this: #+end_src You could then use a variant of the following to inherit from a face -that uses the styles you want and also to preserve the properties -applied by the ~org-todo~ face (in case there is a difference between the -two): +that uses the styles you want and also to preserve the attributes +applied by the ~org-todo~ face (in case there is a difference between +the two): #+begin_src emacs-lisp (setq org-todo-keyword-faces - '(("MEET" . '(bold org-todo)) - ("STUDY" . '(warning org-todo)) - ("WRITE" . '(shadow org-todo)))) + '(("MEET" . (:inherit (bold org-todo))) + ("STUDY" . (:inherit (warning org-todo))) + ("WRITE" . (:inherit (shadow org-todo))))) #+end_src This will refashion the keywords you specify, while letting the other -items in ~org-todo-keywords~ use their original styles (which are defined -in the ~org-todo~ and ~org-done~ faces). +items in ~org-todo-keywords~ use their original styles, which are +defined in the ~org-todo~ and ~org-done~ faces. If you want back the defaults, try specifying just the ~org-todo~ face: @@ -3595,24 +3105,27 @@ If you want back the defaults, try specifying just the ~org-todo~ face: ("WRITE" . org-todo))) #+end_src -When you inherit from multiple faces, you need to quote the list as +Or set ~org-todo-keyword-faces~ to ~nil~. + +When you inherit from multiple faces, you need to do it the way it is shown further above. The order is significant: the first entry is -applied on top of the second, overriding any properties that are -explicitly set for both of them: any property that is not specified is -not overridden, so, for example, if ~org-todo~ has a background and a -foreground, while ~font-lock-type-face~ only has a foreground, the merged -face will include the background of the former and the foreground of the -latter. If you do not want to blend multiple faces, you do not need a -quoted list. A pattern of =keyword . face= will suffice. +applied on top of the second, overriding any attributes that are +explicitly set for both of them: any attribute that is not specified +is not overridden, so, for example, if ~org-todo~ has a background and +a foreground, while ~font-lock-type-face~ only has a foreground, the +merged face will include the background of the former and the +foreground of the latter. If you do not want to blend multiple faces, +you only specify one by name without parentheses or an =:inherit= +keyword. A pattern of =keyword . face= will suffice. Both approaches can be used simultaneously, as illustrated in this configuration of the priority cookies: #+begin_src emacs-lisp (setq org-priority-faces - '((?A . '(bold org-priority)) + '((?A . (:inherit (bold org-priority))) (?B . org-priority) - (?C . '(shadow org-priority)))) + (?C . (:inherit (shadow org-priority))))) #+end_src To find all the faces that are loaded in your current Emacs session, use @@ -3623,11 +3136,9 @@ Their documentation strings will offer you further guidance. Recall that the themes let you retrieve a color from their palette. Do it if you plan to control face attributes. -[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Custom face specs using the themes' palette]]. - [[#h:02e25930-e71a-493d-828a-8907fc80f874][Check color combinations]]. -** Custom Org emphasis faces +** DIY Custom Org emphasis faces :properties: :custom_id: h:26026302-47f4-4471-9004-9665470e7029 :end: @@ -3649,7 +3160,7 @@ specification of that variable looks like this: With the exception of ~org-verbatim~ and ~org-code~ faces, everything else uses the corresponding type of emphasis: a bold typographic weight, or -italicized, underlined, and struck through text. +italicised, underlined, and struck through text. The best way for users to add some extra attributes, such as a foreground color, is to define their own faces and assign them to the @@ -3760,49 +3271,97 @@ styled by the themes, it probably is best not to edit them: That's it! For changes to take effect in already visited Org files, invoke {{{kbd(M-x org-mode-restart)}}}. -** Update Org block delimiter fontification -:properties: -:custom_id: h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50 -:end: - -As noted in the section about ~modus-themes-org-blocks~, Org contains a -variable that determines whether the block's begin and end lines are -extended to the edge of the window ([[#h:b7e328c0-3034-4db7-9cdf-d5ba12081ca2][Option for org-mode block styles]]). -The variable is ~org-fontify-whole-block-delimiter-line~. +** DIY Use colored Org source blocks per language +:PROPERTIES: +:CUSTOM_ID: h:8c842804-43b7-4287-b4e9-8c07d04d1f89 +:END: -Users who change the style of Org blocks from time to time may prefer to -automatically update delimiter line fontification, such as with the -following setup: +[[#h:f44cc6e3-b0f1-4a5e-8a90-9e48fa557b50][DIY Make Org block colors more or less colorful]]. -#+begin_src emacs-lisp -(defun my-modus-themes-org-fontify-block-delimiter-lines () - "Match `org-fontify-whole-block-delimiter-line' to theme style. -Run this function at the post theme load phase, such as with the -`modus-themes-after-load-theme-hook'." - (if (eq modus-themes-org-blocks 'gray-background) - (setq org-fontify-whole-block-delimiter-line t) - (setq org-fontify-whole-block-delimiter-line nil))) +In versions of the Modus themes before =4.4.0= there was an option to +change the coloration of Org source blocks so that certain languages +would have a distinctly colored background. This was not flexible +enough, because (i) we cannot cover all languages effectively and (ii) +the user had no choice over the =language --> color= mapping. -(add-hook 'modus-themes-after-load-theme-hook - #'my-modus-themes-org-fontify-block-delimiter-lines) -#+end_src +As such, the old user option is no more. Users can use the following +to achieve what they want: -Then {{{kbd(M-x org-mode-restart)}}} for changes to take effect, though manual -intervention can be circumvented by tweaking the function thus: +[ All this is done by setting the Org user option ~org-src-block-faces~, + so it is not related to the palette overrides mechanism provided by + the Modus themes. ] #+begin_src emacs-lisp -(defun my-modus-themes-org-fontify-block-delimiter-lines () - "Match `org-fontify-whole-block-delimiter-line' to theme style. -Run this function at the post theme load phase, such as with the -`modus-themes-after-load-theme-hook'." - (if (eq modus-themes-org-blocks 'gray-background) - (setq org-fontify-whole-block-delimiter-line t) - (setq org-fontify-whole-block-delimiter-line nil)) - (when (derived-mode-p 'org-mode) - (font-lock-flush))) -#+end_src - -** Measure color contrast +(defun my-modus-themes-org-block-faces (&rest _) + (modus-themes-with-colors + ;; The `org-src-block-faces' does not get re-applied in existing + ;; Org buffers. Do M-x org-mode-restart for changes to take + ;; effect. + (setq org-src-block-faces + `(("emacs-lisp" modus-themes-nuanced-magenta) + ("elisp" modus-themes-nuanced-magenta) + ("clojure" modus-themes-nuanced-magenta) + ("clojurescript" modus-themes-nuanced-magenta) + ("c" modus-themes-nuanced-blue) + ("c++" modus-themes-nuanced-blue) + ("sh" modus-themes-nuanced-yellow) + ("shell" modus-themes-nuanced-yellow) + ("python" modus-themes-nuanced-yellow) + ("ipython" modus-themes-nuanced-yellow) + ("r" modus-themes-nuanced-yellow) + ("html" modus-themes-nuanced-green) + ("xml" modus-themes-nuanced-green) + ("css" modus-themes-nuanced-red) + ("scss" modus-themes-nuanced-red) + ("yaml" modus-themes-nuanced-cyan) + ("conf" modus-themes-nuanced-cyan) + ("docker" modus-themes-nuanced-cyan))))) + +(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-org-block-faces) +#+end_src + +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][DIY Use a hook at the post-load-theme phase]]. + +Note that the ~org-src-block-faces~ accepts a named face, as shown +above, as well as a list of face attributes. The latter approach is +not good enough because it hardcodes values in such a way that an +~org-mode-restart~ is necessary. Whereas the indirection of the named +face lets the theme change the values while Org buffers continue to +show the right colors. + +Still, if a user prefers to hardcode face attributes, here is the +idea: + +#+begin_src emacs-lisp +;; This is for the sake of completeness. I DO NOT RECOMMEND THIS +;; method because it hardcodes values and thus requires +;; `org-mode-restart' every time you change a theme. +(defun my-modus-themes-org-block-faces (&rest _) + (modus-themes-with-colors + (setq org-src-block-faces + `(("emacs-lisp" (:inherit org-block :background ,bg-magenta-nuanced)) + ("elisp" (:inherit org-block :background ,bg-magenta-nuanced)) + ("clojure" (:inherit org-block :background ,bg-magenta-nuanced)) + ("clojurescript" (:inherit org-block :background ,bg-magenta-nuanced)) + ("c" (:inherit org-block :background ,bg-blue-nuanced)) + ("c++" (:inherit org-block :background ,bg-blue-nuanced)) + ("sh" (:inherit org-block :background ,bg-yellow-nuanced)) + ("shell" (:inherit org-block :background ,bg-yellow-nuanced)) + ("python" (:inherit org-block :background ,bg-yellow-nuanced)) + ("ipython" (:inherit org-block :background ,bg-yellow-nuanced)) + ("r" (:inherit org-block :background ,bg-yellow-nuanced)) + ("html" (:inherit org-block :background ,bg-green-nuanced)) + ("xml" (:inherit org-block :background ,bg-green-nuanced)) + ("css" (:inherit org-block :background ,bg-red-nuanced)) + ("scss" (:inherit org-block :background ,bg-red-nuanced)) + ("yaml" (:inherit org-block :background ,bg-cyan-nuanced)) + ("conf" (:inherit org-block :background ,bg-cyan-nuanced)) + ("docker" (:inherit org-block :background ,bg-cyan-nuanced)))))) + +(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-org-block-faces) +#+end_src + +** DIY Measure color contrast :properties: :custom_id: h:02e25930-e71a-493d-828a-8907fc80f874 :end: @@ -3872,10 +3431,10 @@ palette in large part because certain colors are only meant to be used in combination with some others. Consult the source code for the minutia and relevant commentary. -Such knowledge may prove valuable while attempting to override some of -the themes' colors: [[#h:307d95dd-8dbd-4ece-a543-10ae86f155a6][Override colors]]. +Such knowledge may prove valuable while attempting to customize the +theme's color palette. -** Load theme depending on time of day +** DIY Load theme depending on time of day :properties: :custom_id: h:1d1ef4b4-8600-4a09-993c-6de3af0ddd26 :end: @@ -3884,9 +3443,9 @@ While we do provide ~modus-themes-toggle~ to manually switch between the themes, users may also set up their system to perform such a task automatically at sunrise and sunset. -This can be accomplished by specifying the coordinates of one's location -using the built-in {{{file(solar.el)}}} and then configuring the =circadian= -package: +This can be accomplished by specifying the coordinates of one's +location using the built-in {{{file(solar.el)}}} and then configuring +the ~circadian~ package: #+begin_src emacs-lisp (use-package solar ; built-in @@ -3895,7 +3454,7 @@ package: calendar-longitude 33.36)) (use-package circadian ; you need to install this - :ensure + :ensure t :after solar :config (setq circadian-themes '((:sunrise . modus-operandi) @@ -3903,7 +3462,7 @@ package: (circadian-setup)) #+end_src -** Backdrop for pdf-tools +** DIY Backdrop for pdf-tools :properties: :custom_id: h:ff69dfe1-29c0-447a-915c-b5ff7c5509cd :end: @@ -3924,10 +3483,11 @@ buffer-local value of the ~default~ face. To remap the buffer's backdrop, we start with a function like this one: #+begin_src emacs-lisp -(defun my-pdf-tools-backdrop () - (face-remap-add-relative - 'default - `(:background ,(modus-themes-color 'bg-alt)))) +(defun my-pdf-tools-backdrop (&rest _) + (modus-themes-with-colors + (face-remap-add-relative + 'default + `(:background ,bg-dim)))) (add-hook 'pdf-tools-enabled-hook #'my-pdf-tools-backdrop) #+end_src @@ -3937,7 +3497,8 @@ The idea is to assign that function to a hook that gets called when when you only use one theme. However it has the downside of setting the background color value only at render time. In other words, the face remapping function does not get evaluated anew whenever the theme -changes, such as upon invoking {{{kbd(M-x modus-themes-toggle)}}}. +changes, such as upon invoking {{{kbd(M-x modus-themes-toggle)}}} +([[#h:4fbfed66-5a89-447a-a07d-a03f6819c5bd][Option for which themes to toggle]]). To have our face remapping adapt gracefully while switching between the Modus themes, we need to also account for the current theme and control @@ -3945,19 +3506,20 @@ the activation of ~pdf-view-midnight-minor-mode~. To which end we arrive at something like the following, which builds on the above example: #+begin_src emacs-lisp -(defun my-pdf-tools-backdrop () - (face-remap-add-relative - 'default - `(:background ,(modus-themes-color 'bg-alt)))) +(defun my-pdf-tools-backdrop (&rest _) + (modus-themes-with-colors + (face-remap-add-relative + 'default + `(:background ,bg-dim)))) -(defun my-pdf-tools-midnight-mode-toggle () +(defun my-pdf-tools-midnight-mode-toggle (&rest _) (when (derived-mode-p 'pdf-view-mode) (if (eq (car custom-enabled-themes) 'modus-vivendi) (pdf-view-midnight-minor-mode 1) (pdf-view-midnight-minor-mode -1)) (my-pdf-tools-backdrop))) -(defun my-pdf-tools-themes-toggle () +(defun my-pdf-tools-themes-toggle (&rest _) (mapc (lambda (buf) (with-current-buffer buf @@ -3968,106 +3530,15 @@ at something like the following, which builds on the above example: (add-hook 'modus-themes-after-load-theme-hook #'my-pdf-tools-themes-toggle) #+end_src +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + With those in place, PDFs have a distinct backdrop for their page, while buffers with major-mode as ~pdf-view-mode~ automatically switches to dark mode when ~modus-themes-toggle~ is called. -** Decrease mode line height -:properties: -:custom_id: h:03be4438-dae1-4961-9596-60a307c070b5 -:end: -#+cindex: Decrease mode line height - -By default, the mode line of the Modus themes is set to 1 pixel width -for its =:box= attribute. In contrast, the mode line of stock Emacs is -1 -pixel. This small difference is considered necessary for the purposes -of accessibility as our out-of-the-box design has a prominent color -around the mode line (a border) to make its boundaries clear. With a -negative width the border and the text on the mode line can feel a bit -more difficult to read under certain scenaria. - -Furthermore, the user option ~modus-themes-mode-line~ ([[#h:27943af6-d950-42d0-bc23-106e43f50a24][Mode line]]) does not -allow for such a negative value because there are many edge cases that -simply make for a counter-intuitive set of possibilities, such as a =0= -value not being acceptable by the underlying face infrastructure, and -negative values greater than =-2= not being particularly usable. - -For these reasons, users who wish to decrease the overall height of the -mode line must handle things on their own by implementing the methods -for face customization documented herein. - -[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Basic face customization]]. - -One such method is to create a function that configures the desired -faces and hook it to ~modus-themes-after-load-theme-hook~ so that it -persists while switching between the Modus themes with the command -~modus-themes-toggle~. - -This one simply disables the box altogether, which will reduce the -height of the mode lines, but also remove their border: - -#+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (set-face-attribute 'mode-line nil :box nil) - (set-face-attribute 'mode-line-inactive nil :box nil)) - -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) -#+end_src - -The above relies on the ~set-face-attribute~ function, though users who -plan to reuse colors from the theme and do so at scale are better off -with the more streamlined combination of the ~modus-themes-with-colors~ -macro and ~custom-set-faces~. - -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face customization at scale]]. - -As explained before in this document, this approach has a syntax that is -consistent with the source code of the themes, so it probably is easier -to reuse parts of the design. - -The following emulates the stock Emacs style, while still using the -colors of the Modus themes (whichever attribute is not explicitly stated -is inherited from the underlying theme): - -#+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (modus-themes-with-colors - (custom-set-faces - `(mode-line ((,class :box (:line-width -1 :style released-button)))) - `(mode-line-inactive ((,class :box (:line-width -1 :color ,bg-region))))))) - -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) -#+end_src - -And this one is like the out-of-the-box style of the Modus themes, but -with the -1 height instead of 1: +Reload the theme for changes to take effect. -#+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (modus-themes-with-colors - (custom-set-faces - `(mode-line ((,class :box (:line-width -1 :color ,fg-alt)))) - `(mode-line-inactive ((,class :box (:line-width -1 :color ,bg-region))))))) - -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) -#+end_src - -Finally, to also change the background color of the active mode line, -such as that it looks like the "accented" variant which is possible via -the user option ~modus-themes-mode-line~, the =:background= attribute needs -to be specified as well: - -#+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (modus-themes-with-colors - (custom-set-faces - `(mode-line ((,class :box (:line-width -1 :color ,fg-alt) :background ,bg-active-accent))) - `(mode-line-inactive ((,class :box (:line-width -1 :color ,bg-region))))))) - -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) -#+end_src - -** Toggle themes without reloading them +** DIY Toggle themes without reloading them :properties: :custom_id: h:b40aca50-a3b2-4c43-be58-2c26fcd14237 :end: @@ -4096,291 +3567,110 @@ manual." Recall that ~modus-themes-toggle~ uses ~load-theme~. -** A theme-agnostic hook for theme loading -:properties: -:custom_id: h:86f6906b-f090-46cc-9816-1fe8aeb38776 -:end: - -The themes are designed with the intent to be useful to Emacs users of -varying skill levels, from beginners to experts. This means that we try -to make things easier by not expecting anyone reading this document to -be proficient in Emacs Lisp or programming in general. - -Such a case is with the use of the ~modus-themes-after-load-theme-hook~, -which runs after ~modus-themes-toggle~, ~modus-themes-load-operandi~, or -~modus-themes-load-vivendi~ is evaluated. We recommend using that hook -for advanced customizations, because (1) we know for sure that it is -available once the themes are loaded, and (2) anyone consulting this -manual, especially the sections on enabling and loading the themes, will -be in a good position to benefit from that hook. - -Advanced users who have a need to switch between the Modus themes and -other items will find that such a hook does not meet their requirements: -it only works with the Modus themes and only with the aforementioned -functions. +** DIY Use more spacious margins or padding in Emacs frames +:PROPERTIES: +:CUSTOM_ID: h:43bcb5d0-e25f-470f-828c-662cee9e21f1 +:END: -A theme-agnostic setup can be configured thus: +[ UPDATE 2023-06-25: Instead of following these instructions, you can + simply install my ~spacious-padding~ package from GNU ELPA. It + implements the padding and provides relevant user options. ] -#+begin_src emacs-lisp -(defvar after-enable-theme-hook nil - "Normal hook run after enabling a theme.") +By default, Emacs frames try to maximize the number of characters that +fit in the current visible portion of the buffer. Users may prefer to +have some extra padding instead. This can make Emacs frames look more +pleasant, but also make it easier to identify the currently active +window. -(defun run-after-enable-theme-hook (&rest _args) - "Run `after-enable-theme-hook'." - (run-hooks 'after-enable-theme-hook)) +The way to implement such padding is two-fold: -(advice-add 'enable-theme :after #'run-after-enable-theme-hook) -#+end_src +1. In the =early-init.el= file instruct Emacs to use a higher value + for the ~internal-border-width~ of all frames, as well as for the + ~right-divider-width~. The former concerns the outer boundaries of + Emacs frames, while the latter pertains to dividers between Emacs + windows. -This creates the ~after-enable-theme-hook~ and makes it run after each -call to ~enable-theme~, which means that it will work for all themes and -also has the benefit that it does not depend on functions such as -~modus-themes-toggle~ and the others mentioned above. ~enable-theme~ is -called internally by ~load-theme~, so the hook works everywhere. +2. Make the relevant faces invisible by changing the value of their + relevant attributes to that of the current theme's main background. -Now this specific piece of Elisp may be simple for experienced users, -but it is not easy to read for newcomers, including the author of the -Modus themes for the first several months of their time as an Emacs -user. Hence our hesitation to recommend it as part of the standard -setup of the Modus themes (it is generally a good idea to understand -what the implications are of advising a function). +The parameters of Emacs frames are specified in the variables +~initial-frame-alist~ and ~default-frame-alist~. The "initial frame" +refers to the first frame that appears on Emacs startup. The +"default" refers to the fallback values that apply to all other frames +that Emacs creates (unless those are explicitly overridden by a +bespoke ~make-frame~ call). -** Diffs with only the foreground -:properties: -:custom_id: h:e2aed9eb-5e1e-45ec-bbd7-bc4faeab3236 -:end: -#+cindex: Foreground-only diffs +In detail, first we use the same values for the two frame alist variables: -Buffers that show differences between versions of a file or buffer, such -as in ~diff-mode~ and ~ediff~ always use color-coded background and -foreground combinations. +#+begin_src emacs-lisp +;; This must go in the early-init.el so that it applies to the initial +;; frame. +(dolist (var '(default-frame-alist initial-frame-alist)) + (add-to-list var '(right-divider-width . 20)) + (add-to-list var '(internal-border-width . 20))) +#+end_src -[[#h:ea7ac54f-5827-49bd-b09f-62424b3b6427][Option for diff buffer looks]]. +What the ~dolist~ does is to call ~add-to-list~ for the two variables +we specify there. This economizes on typing. -User may, however, prefer a style that removes the color-coded -backgrounds from regular changes while keeping them for word-wise (aka -"refined") changes---backgrounds for word-wise diffs are helpful in -context. To make this happen, one can use the ~modus-themes-with-colors~ -macro ([[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]): +Then we define a function that makes the relevant faces invisible. +The reason we do this with a function is so we can hook it to the +"post load" phase of a theme, thus applying the new background value +(otherwise you keep the old background, which likely means that the +faces will no longer be invisible). #+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (modus-themes-with-colors +(defun my-modus-themes-invisible-dividers (&rest _) + "Make window dividers invisible. +Add this to the `modus-themes-post-load-hook'." + (let ((bg (face-background 'default))) (custom-set-faces - `(modus-themes-diff-added ((,class :background unspecified :foreground ,green))) ; OR ,blue for deuteranopia - `(modus-themes-diff-changed ((,class :background unspecified :foreground ,yellow))) - `(modus-themes-diff-removed ((,class :background unspecified :foreground ,red))) - - `(modus-themes-diff-refine-added ((,class :background ,bg-diff-added :foreground ,fg-diff-added))) - ;; `(modus-themes-diff-refine-added ((,class :background ,bg-diff-added-deuteran :foreground ,fg-diff-added-deuteran))) - `(modus-themes-diff-refine-changed ((,class :background ,bg-diff-changed :foreground ,fg-diff-changed))) - `(modus-themes-diff-refine-removed ((,class :background ,bg-diff-removed :foreground ,fg-diff-removed))) - - `(modus-themes-diff-focus-added ((,class :background ,bg-dim :foreground ,green))) ; OR ,blue for deuteranopia - `(modus-themes-diff-focus-changed ((,class :background ,bg-dim :foreground ,yellow))) - `(modus-themes-diff-focus-removed ((,class :background ,bg-dim :foreground ,red))) - - `(modus-themes-diff-heading ((,class :background ,bg-alt :foreground ,fg-main))) - - `(diff-indicator-added ((,class :foreground ,green))) ; OR ,blue for deuteranopia - `(diff-indicator-changed ((,class :foreground ,yellow))) - `(diff-indicator-removed ((,class :foreground ,red))) + `(fringe ((t :background ,bg :foreground ,bg))) + `(window-divider ((t :background ,bg :foreground ,bg))) + `(window-divider-first-pixel ((t :background ,bg :foreground ,bg))) + `(window-divider-last-pixel ((t :background ,bg :foreground ,bg)))))) - `(magit-diff-added ((,class :background unspecified :foreground ,green-faint))) - `(magit-diff-changed ((,class :background unspecified :foreground ,yellow-faint))) - `(magit-diff-removed ((,class :background unspecified :foreground ,red-faint))) - `(magit-diff-context-highlight ((,class :background ,bg-dim :foreground ,fg-dim)))))) - -;; This is so that the changes persist when switching between -;; `modus-operandi' and `modus-vivendi'. -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) +(add-hook 'modus-themes-post-load-hook #'my-modus-themes-invisible-dividers) #+end_src -This used to be an optional style of ~modus-themes-diffs~, but has been -removed since version =2.0.0= to ensure that the accessibility standard -and aesthetic quality of the themes is not compromised. - -** Ediff without diff color-coding -:properties: -:custom_id: h:b0b31802-0216-427e-b071-1a47adcfe608 -:end: - -Ediff uses the same color-coding as ordinary diffs in ~diff-mode~, Magit, -etc. ([[#h:ea7ac54f-5827-49bd-b09f-62424b3b6427][Option for diff buffer looks]]). This is consistent with the -principle of least surprise. - -Users may, however, prefer to treat Ediff differently on the premise -that it does not need any particular color-coding to show added or -removed lines/words: it does not use the =+= or =-= markers, after all. +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. -This can be achieved by customizing the Ediff faces with color -combinations that do not carry the same connotations as those of diffs. -Consider this example, which leverages the ~modus-themes-with-colors~ -macro ([[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]): +The above will work only for themes that belong to the Modus family. +For users of Emacs version 29 or higher, there exists a theme-agnostic +hook that takes a function with one argument---that of the theme---and +calls in the the "post enable" phase of theme loading. Here is the +above snippet, with the necessary tweaks: #+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () - (modus-themes-with-colors +(defun my-modus-themes-invisible-dividers (&rest _) + "Make window dividers for THEME invisible." + (let ((bg (face-background 'default))) (custom-set-faces - `(ediff-current-diff-A ((,class :inherit unspecified :background ,bg-special-faint-cold :foreground ,fg-special-cold))) - `(ediff-current-diff-B ((,class :inherit unspecified :background ,bg-special-faint-warm :foreground ,fg-special-warm))) - `(ediff-current-diff-C ((,class :inherit unspecified :background ,bg-special-faint-calm :foreground ,fg-special-calm))) - `(ediff-fine-diff-A ((,class :inherit unspecified :background ,bg-special-cold :foreground ,fg-special-cold))) - `(ediff-fine-diff-B ((,class :inherit unspecified :background ,bg-special-warm :foreground ,fg-special-warm))) - `(ediff-fine-diff-C ((,class :inherit unspecified :background ,bg-special-calm :foreground ,fg-special-calm)))))) - -;; This is so that the changes persist when switching between -;; `modus-operandi' and `modus-vivendi'. -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) -#+end_src + `(fringe ((t :background ,bg :foreground ,bg))) + `(window-divider ((t :background ,bg :foreground ,bg))) + `(window-divider-first-pixel ((t :background ,bg :foreground ,bg))) + `(window-divider-last-pixel ((t :background ,bg :foreground ,bg)))))) -Remove the =:foreground= and its value to preserve the underlying -coloration. +(add-hook 'enable-theme-functions #'my-modus-themes-invisible-dividers) +#+end_src -[[#h:f4d4b71b-2ca5-4c3d-b0b4-9bfd7aa7fb4d][Visualize the active Modus theme's palette]]. +Users of older versions of Emacs can read the entry herein about +defining their own theme-agnostic hook ([[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][A theme-agnostic hook for theme loading]]). -** Near-monochrome syntax highlighting -:properties: -:custom_id: h:c1f3fa8e-7a63-4a6f-baf3-a7febc0661f0 -:end: -#+cindex: Monochrome code syntax - -While the Modus themes do provide a user option to control the overall -style of syntax highlighting in programming major modes, they do not -cover the possibility of a monochromatic or near-monochromatic design -([[#h:c119d7b2-fcd4-4e44-890e-5e25733d5e52][Option for syntax highlighting]]). This is due to the multitude of -preferences involved: one may like comments to be styled with an accent -value, another may want certain constructs to be bold, a third may apply -italics to doc strings but not comments... The possibilities are -virtually endless. As such, this sort of design is best handled at the -user level in accordance with the information furnished elsewhere in -this manual. - -[[#h:1487c631-f4fe-490d-8d58-d72ffa3bd474][Case-by-case face specs using the themes' palette]]. - -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. - -The gist is that we want to override the font-lock faces. For our -changes to persist while switching between ~modus-operandi~ and -~modus-vivendi~ we wrap our face overrides in a function that we hook to -~modus-themes-after-load-theme-hook~. - -Users who want to replicate the structure of the themes' source code are -advised to use the examples with ~custom-set-faces~. Those who prefer a -different approach can use the snippets which call ~set-face-attribute~. -Below are the code blocks. - -The following uses a yellow accent value for comments and green hues for -strings. Regexp grouping constructs have color values that work in the -context of a green string. All other elements use the main foreground -color, except warnings such as the ~user-error~ function in Elisp -buffers which gets a subtle red tint (not to be confused with the -~warning~ face which is used for genuine warnings). Furthermore, notice -the ~modus-themes-bold~ and ~modus-themes-slant~ which apply the -preference set in the user options ~modus-themes-bold-constructs~ and -~modus-themes-italic-constructs~, respectively. Users who do not want -this conditionally must replace these faces with ~bold~ and ~italic~ -respectively (or ~unspecified~ to disable the effect altogether). - -#+begin_src emacs-lisp -;; This is the hook. It will not be replicated across all code samples. -(add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-subtle-syntax) - -(defun my-modus-themes-subtle-syntax () - (modus-themes-with-colors - (custom-set-faces - `(font-lock-builtin-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-comment-delimiter-face ((,class :inherit font-lock-comment-face))) - `(font-lock-comment-face ((,class :inherit unspecified :foreground ,fg-comment-yellow))) - `(font-lock-constant-face ((,class :foreground unspecified))) - `(font-lock-doc-face ((,class :inherit modus-themes-slant :foreground ,fg-special-mild))) - `(font-lock-function-name-face ((,class :foreground unspecified))) - `(font-lock-keyword-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-negation-char-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-preprocessor-face ((,class :foreground unspecified))) - `(font-lock-regexp-grouping-backslash ((,class :inherit bold :foreground ,yellow))) - `(font-lock-regexp-grouping-construct ((,class :inherit bold :foreground ,blue-alt-other))) - `(font-lock-string-face ((,class :foreground ,green-alt-other))) - `(font-lock-type-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-variable-name-face ((,class :foreground unspecified))) - `(font-lock-warning-face ((,class :inherit modus-themes-bold :foreground ,red-nuanced-fg)))))) - -;; Same as above with `set-face-attribute' instead of `custom-set-faces' -(defun my-modus-themes-subtle-syntax () - (modus-themes-with-colors - (set-face-attribute 'font-lock-builtin-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-comment-delimiter-face nil :inherit 'font-lock-comment-face) - (set-face-attribute 'font-lock-comment-face nil :inherit 'unspecified :foreground fg-comment-yellow) - (set-face-attribute 'font-lock-constant-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-doc-face nil :inherit 'modus-themes-slant :foreground fg-special-mild) - (set-face-attribute 'font-lock-function-name-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-keyword-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-negation-char-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-preprocessor-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-regexp-grouping-backslash nil :inherit 'bold :foreground yellow) - (set-face-attribute 'font-lock-regexp-grouping-construct nil :inherit 'bold :foreground blue-alt-other) - (set-face-attribute 'font-lock-string-face nil :foreground green-alt-other) - (set-face-attribute 'font-lock-type-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-variable-name-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-warning-face nil :inherit 'modus-themes-bold :foreground red-nuanced-fg))) -#+end_src - -The following sample is the same as above, except strings are blue and -comments are gray. Regexp constructs are adapted accordingly. - -#+begin_src emacs-lisp -(defun my-modus-themes-subtle-syntax () - (modus-themes-with-colors - (custom-set-faces - `(font-lock-builtin-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-comment-delimiter-face ((,class :inherit font-lock-comment-face))) - `(font-lock-comment-face ((,class :inherit unspecified :foreground ,fg-alt))) - `(font-lock-constant-face ((,class :foreground unspecified))) - `(font-lock-doc-face ((,class :inherit modus-themes-slant :foreground ,fg-docstring))) - `(font-lock-function-name-face ((,class :foreground unspecified))) - `(font-lock-keyword-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-negation-char-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-preprocessor-face ((,class :foreground unspecified))) - `(font-lock-regexp-grouping-backslash ((,class :inherit bold :foreground ,fg-escape-char-backslash))) - `(font-lock-regexp-grouping-construct ((,class :inherit bold :foreground ,fg-escape-char-construct))) - `(font-lock-string-face ((,class :foreground ,blue-alt))) - `(font-lock-type-face ((,class :inherit modus-themes-bold :foreground unspecified))) - `(font-lock-variable-name-face ((,class :foreground unspecified))) - `(font-lock-warning-face ((,class :inherit modus-themes-bold :foreground ,red-nuanced-fg)))))) - -;; Same as above with `set-face-attribute' instead of `custom-set-faces' -(defun my-modus-themes-subtle-syntax () - (modus-themes-with-colors - (set-face-attribute 'font-lock-builtin-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-comment-delimiter-face nil :inherit 'font-lock-comment-face) - (set-face-attribute 'font-lock-comment-face nil :inherit 'unspecified :foreground fg-alt) - (set-face-attribute 'font-lock-constant-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-doc-face nil :inherit 'modus-themes-slant :foreground fg-docstring) - (set-face-attribute 'font-lock-function-name-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-keyword-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-negation-char-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-preprocessor-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-regexp-grouping-backslash nil :inherit 'bold :foreground fg-escape-char-backslash) - (set-face-attribute 'font-lock-regexp-grouping-construct nil :inherit 'bold :foreground fg-escape-char-construct) - (set-face-attribute 'font-lock-string-face nil :foreground blue-alt) - (set-face-attribute 'font-lock-type-face nil :inherit 'modus-themes-bold :foreground 'unspecified) - (set-face-attribute 'font-lock-variable-name-face nil :foreground 'unspecified) - (set-face-attribute 'font-lock-warning-face nil :inherit 'modus-themes-bold :foreground red-nuanced-fg))) -#+end_src - -** Custom hl-todo colors +** DIY Custom hl-todo colors :PROPERTIES: :CUSTOM_ID: h:2ef83a21-2f0a-441e-9634-473feb940743 :END: -The =hl-todo= package provides the user option ~hl-todo-keyword-faces~: -it specifies a pair of keyword and corresponding color value. The Modus -themes configure that option in the interest of legibility. While this -works for our purposes, users may still prefer to apply their custom -values, in which case the following approach is necessary: +The ~hl-todo~ package provides the user option +~hl-todo-keyword-faces~: it specifies a pair of keyword and +corresponding color value. The Modus themes configure that option in +the interest of legibility. While this works for our purposes, users +may still prefer to apply their custom values, in which case the +following approach is necessary: #+begin_src emacs-lisp -(defun my-modus-themes-hl-todo-faces () +(defun my-modus-themes-hl-todo-faces (&rest _) (setq hl-todo-keyword-faces '(("TODO" . "#ff0000") ("HACK" . "#ffff00") ("XXX" . "#00ffff") @@ -4389,10 +3679,12 @@ values, in which case the following approach is necessary: (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-hl-todo-faces) #+end_src +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + Or include a ~let~ form, if needed: #+begin_src emacs-lisp -(defun my-modus-themes-hl-todo-faces () +(defun my-modus-themes-hl-todo-faces (&rest _) (let ((red "#ff0000") (blue "#0000ff")) (setq hl-todo-keyword-faces `(("TODO" . ,blue) @@ -4403,15 +3695,19 @@ Or include a ~let~ form, if needed: (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-hl-todo-faces) #+end_src +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + Normally, we do not touch user options, though this is an exception: otherwise the defaults are not always legible. -** Add support for solaire-mode +Reload the theme for changes to take effect. + +** DIY Add support for solaire-mode :PROPERTIES: :CUSTOM_ID: h:439c9e46-52e2-46be-b1dc-85841dd99671 :END: -The =solaire-mode= package dims the background of what it considers +The ~solaire-mode~ package dims the background of what it considers ancillary "UI" buffers, such as the minibuffer and Dired buffers. The Modus themes used to support Solaire on the premise that the user was (i) opting in to it, (ii) understood why certain buffers were more gray, @@ -4441,28 +3737,127 @@ arrangement that compromises on our accessibility standards and/or hinders our efforts to provide the best possible experience while using the Modus themes. -As such, =solaire-mode= is not---and will not be---supported by the +As such, ~solaire-mode~ is not---and will not be---supported by the Modus themes (or any other of my themes, for that matter). Users who want it must style the faces manually. Below is some sample code, based on what we cover at length elsewhere in this manual: [[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]. -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. #+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () +(defun my-modus-themes-custom-faces (&rest _) (modus-themes-with-colors (custom-set-faces - `(solaire-default-face ((,class :inherit default :background ,bg-alt :foreground ,fg-dim))) - `(solaire-line-number-face ((,class :inherit solaire-default-face :foreground ,fg-unfocused))) - `(solaire-hl-line-face ((,class :background ,bg-active))) - `(solaire-org-hide-face ((,class :background ,bg-alt :foreground ,bg-alt)))))) + `(solaire-default-face ((,c :inherit default :background ,bg-dim :foreground ,fg-dim))) + `(solaire-line-number-face ((,c :inherit solaire-default-face :foreground ,fg-unfocused))) + `(solaire-hl-line-face ((,c :background ,bg-active))) + `(solaire-org-hide-face ((,c :background ,bg-dim :foreground ,bg-dim)))))) (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) #+end_src -As always, re-load the theme for changes to take effect. +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + +Reload the theme for changes to take effect. + +** DIY Use a hook at the post-load-theme phase +:PROPERTIES: +:CUSTOM_ID: h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24 +:END: + +Many of the Do-It-Yourself (DIY) snippets provided herein make use of +a hook to apply the desired changes. In most examples, this hook is +the ~modus-themes-after-load-theme-hook~ (alias ~modus-themes-post-load-hook~). +This hook is provided by the Modus themes and is called at the end of +one the following: + +- Command ~modus-themes-toggle~ :: [[#h:4fbfed66-5a89-447a-a07d-a03f6819c5bd][Option for which themes to toggle]]. + +- Command ~modus-themes-select~ :: Select a Modus theme using minibuffer + completion and then load it. + +- Function ~modus-themes-load-theme~ :: Called only from Lisp, such as + in the user's init file, with the quoted symbol of a Modus theme as + an argument ([[#h:adb0c49a-f1f9-4690-868b-013a080eed68][Option for disabling other themes while loading Modus]]). + This function is used internally by ~modus-themes-toggle~ and + ~modus-themes-select~. + +Users who switch between themes that are not limited to the Modus +collection cannot benefit from the aforementioned hook: it only works +with the Modus themes. A theme-agnostic hook is needed in such a case. +Before Emacs 29, this had to be set up manually ([[#h:86f6906b-f090-46cc-9816-1fe8aeb38776][DIY A theme-agnostic hook for theme loading]]). +Starting with Emacs 29, the special hook ~enable-theme-functions~ +works with anything that uses the basic ~enable-theme~ function. + +To use the ~enable-theme-functions~ just add the given function to it +the way it is done with every hook: + +#+begin_src emacs-lisp +(add-hook 'enable-theme-functions 'MY-FUNCTION-HERE) +#+end_src + +Functions added to ~enable-theme-functions~ accept a single =THEME= +argument. The examples shown in this manual use the pattern =(&rest +_)=, which is how a function accepts one or more arguments but +declares it will not use them (in plain terms, the code works with or +without ~enable-theme-functions~). + +*** DIY A theme-agnostic hook for theme loading +:properties: +:custom_id: h:86f6906b-f090-46cc-9816-1fe8aeb38776 +:end: + +[ NOTE: The following is for versions of Emacs before 29. For Emacs 29 + or higher, users can rely on the built-in ~enable-theme-functions~ + ([[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]). ] + +The themes are designed with the intent to be useful to Emacs users of +varying skill levels, from beginners to experts. This means that we try +to make things easier by not expecting anyone reading this document to +be proficient in Emacs Lisp or programming in general. + +Such a case is with the use of ~modus-themes-after-load-theme-hook~, +which runs after the ~modus-themes-load-theme~ function (used by the +command ~modus-themes-toggle~). We recommend using that hook for +advanced customizations, because (1) we know for sure that it is +available once the themes are loaded, and (2) anyone consulting this +manual, especially the sections on enabling and loading the themes, +will be in a good position to benefit from that hook. + +Advanced users who have a need to switch between the Modus themes and +other items will find that such a hook does not meet their requirements: +it only works with the Modus themes and only with the aforementioned +functions. + +A theme-agnostic setup can be configured thus: + +#+begin_src emacs-lisp +(defvar after-enable-theme-hook nil + "Normal hook run after enabling a theme.") + +(defun run-after-enable-theme-hook (&rest _args) + "Run `after-enable-theme-hook'." + (run-hooks 'after-enable-theme-hook)) + +(advice-add 'enable-theme :after #'run-after-enable-theme-hook) +#+end_src + +This creates the ~after-enable-theme-hook~ and makes it run after each +call to ~enable-theme~, which means that it will work for all themes and +also has the benefit that it does not depend on functions such as +~modus-themes-toggle~ and the others mentioned above. ~enable-theme~ is +called internally by ~load-theme~, so the hook works everywhere. + +The downside of the theme-agnostic hook is that any functions added to +it will likely not be able to benefit from macro calls that read the +active theme, such as ~modus-themes-with-colors~. Not all Emacs +themes have the same capabilities. + +In this document, we cover ~modus-themes-after-load-theme-hook~ though +the user can replace it with ~after-enable-theme-hook~ should they +need to (provided they understand the implications). * Face coverage :properties: @@ -4487,55 +3882,45 @@ affected face groups. The items with an appended asterisk =*= tend to have lots of extensions, so the "full support" may not be 100% true… + ace-window -+ alert ++ agda2-mode + all-the-icons + all-the-icons-dired + all-the-icons-ibuffer + annotate + ansi-color + anzu -+ apropos -+ artbollocks-mode + auctex and TeX + auto-dim-other-buffers + avy -+ awesome-tray + bbdb + binder -+ bm ++ breadcrumb + bongo + boon + bookmark -+ breakpoint (provided by the built-in {{{file(gdb-mi.el)}}} library) + calendar and diary -+ calfw -+ calibredb + centaur-tabs -+ cfrs + change-log and log-view (such as ~vc-print-log~, ~vc-print-root-log~) + chart + cider + circe + citar -+ color-rg ++ clojure-mode + column-enforce-mode + company-mode* -+ company-posframe + compilation-mode + completions + consult + corfu ++ corfu-candidate-overlay + corfu-quick + counsel* -+ counsel-css -+ cov + cperl-mode + crontab-mode -+ css-mode + csv-mode + ctrlf + custom (what you get with {{{kbd(M-x customize)}}}) -+ dap-mode ++ dashboard + deadgrep + debbugs + deft @@ -4545,7 +3930,6 @@ have lots of extensions, so the "full support" may not be 100% true… + diff-hl + diff-mode + dim-autoload -+ dir-treeview + dired + dired-async + dired-git @@ -4553,11 +3937,9 @@ have lots of extensions, so the "full support" may not be 100% true… + dired-narrow + dired-subtree + diredfl -+ diredp (dired+) ++ disk-usage + display-fill-column-indicator-mode + doom-modeline -+ easy-jekyll -+ ebdb + ediff + ein (Emacs IPython Notebook) + eglot @@ -4571,36 +3953,24 @@ have lots of extensions, so the "full support" may not be 100% true… + emms + enh-ruby-mode (enhanced-ruby-mode) + epa -+ equake + erc -+ eros + ert ++ erts-mode + eshell + eshell-fringe-status -+ eshell-git-prompt -+ eshell-prompt-extras (epe) -+ eshell-syntax-highlighting + evil* (evil-mode) -+ evil-goggles -+ evil-snipe -+ evil-visual-mark-mode + eww + exwm + eyebrowse -+ fancy-dabbrev + flycheck + flycheck-color-mode-line + flycheck-indicator -+ flycheck-posframe + flymake + flyspell + flx -+ freeze-it + focus + fold-this + font-lock (generic syntax highlighting) -+ forge -+ fountain (fountain-mode) + geiser + git-commit + git-gutter (and variants) @@ -4609,23 +3979,16 @@ have lots of extensions, so the "full support" may not be 100% true… + gnus + gotest + golden-ratio-scroll-screen -+ helm* -+ helm-ls-git -+ helm-switch-shell -+ helm-xref + helpful -+ highlight-indentation + highlight-numbers + highlight-parentheses ([[#h:24bab397-dcb2-421d-aa6e-ec5bd622b913][Note on highlight-parentheses.el]]) + highlight-thing -+ hl-defined + hl-fill-column + hl-line-mode + hl-todo + hydra + ibuffer + icomplete -+ icomplete-vertical + ido-mode + iedit + iflipb @@ -4635,43 +3998,40 @@ have lots of extensions, so the "full support" may not be 100% true… + info + info+ (info-plus) + info-colors -+ interaction-log + ioccur + isearch, occur, etc. + ivy* + ivy-posframe ++ japanese-holidays + jira (org-jira) ++ jit-spell ++ jinx + journalctl-mode + js2-mode + julia -+ jupyter + kaocha-runner + keycast + ledger-mode + leerzeichen + line numbers (~display-line-numbers-mode~ and global variant) -+ lsp-mode -+ lsp-ui -+ macrostep + magit -+ magit-imerge + make-mode + man + marginalia + markdown-mode + markup-faces (~adoc-mode~) -+ mentor ++ mct + messages -+ mini-modeline + minimap -+ mmm-mode + mode-line + mood-line -+ moody + mpdel + mu4e + multiple-cursors -+ nano-modeline ++ nerd-icons ++ nerd-icons-completion ++ nerd-icons-dired ++ nerd-icons-ibuffer + neotree + notmuch + num3-mode @@ -4698,11 +4058,8 @@ have lots of extensions, so the "full support" may not be 100% true… + pdf-tools + persp-mode + perspective -+ phi-grep -+ pomidor + popup + powerline -+ powerline-evil + prism ([[#h:a94272e0-99da-4149-9e80-11a7e67a2cf2][Note for prism.el]]) + prescient + proced @@ -4710,19 +4067,16 @@ have lots of extensions, so the "full support" may not be 100% true… + pulse + pyim + quick-peek -+ racket-mode -+ rainbow-blocks + rainbow-delimiters + rcirc ++ rcirc-color + recursion-indicator + regexp-builder (also known as ~re-builder~) + rg (rg.el) + ripgrep + rmail ++ rst-mode + ruler-mode -+ selectrum -+ selectrum-prescient -+ semantic + sesman + shell-script-mode + shortdoc @@ -4734,32 +4088,25 @@ have lots of extensions, so the "full support" may not be 100% true… + slime (slbd) + sly + smart-mode-line -+ smartparens + smerge -+ spaceline + speedbar + spell-fu + stripes + suggest + switch-window + swiper -+ sx + symbol-overlay + syslog-mode -+ tab-bar-groups + tab-bar-mode + tab-line-mode + table (built-in {{{file(table.el)}}}) + telega -+ telephone-line + terraform-mode + term + textsec -+ tomatinho + transient (pop-up windows such as Magit's) + trashed + tree-sitter -+ treemacs + tty-menu + tuareg + typescript @@ -4779,11 +4126,9 @@ have lots of extensions, so the "full support" may not be 100% true… + which-key + whitespace-mode + window-divider-mode -+ winum + writegood-mode + woman + xah-elisp-mode -+ xref + xterm-color (and ansi-colors) + yaml-mode + yasnippet @@ -4802,34 +4147,46 @@ inherit from some basic faces or their dependencies which are directly supported by the themes. + ag ++ apropos + apt-sources-list ++ bbdb ++ bm ++ breakpoint (provided by the built-in {{{file(gdb-mi.el)}}} library) + buffer-expose + bufler + counsel-notmuch + counsel-org-capture-string ++ css-mode + dashboard (emacs-dashboard) + define-word ++ denote + disk-usage + dtache + dynamic-ruler + easy-kill ++ ebdb + edit-indirect + egerrit + elfeed-summary + evil-owl + flyspell-correct + fortran-mode ++ freeze-it ++ forge + git-walktree + goggles + highlight-defined + highlight-escape-sequences (~hes-mode~) ++ icomplete-vertical + i3wm-config-mode ++ lin + minibuffer-line + no-emoji + org-remark + parrot + perl-mode + php-mode ++ pulsar + rjsx-mode + side-hustle + spell-fu @@ -4840,6 +4197,7 @@ supported by the themes. + vdiff + vertico-indexed + vertico-mouse ++ xref * Notes on individual packages :properties: @@ -4883,11 +4241,12 @@ anew. :CUSTOM_ID: h:a195e37c-e58c-4148-b254-8ba1ed8a731a :END: -The =git-gutter= and =git-gutter-fr= packages default to drawing bitmaps -for the indicators they display (e.g. bitmap of a plus sign for added -lines). In Doom Emacs, these bitmaps are replaced with contiguous lines -which may look nicer, but require a change to the foreground of the -relevant faces to yield the desired color combinations. +The ~git-gutter~ and ~git-gutter-fr~ packages default to drawing +bitmaps for the indicators they display (e.g. bitmap of a plus sign +for added lines). In Doom Emacs, these bitmaps are replaced with +contiguous lines which may look nicer, but require a change to the +foreground of the relevant faces to yield the desired color +combinations. Since this is Doom-specific, we urge users to apply changes in their local setup. Below is some sample code, based on what we cover at @@ -4895,20 +4254,27 @@ length elsewhere in this manual: [[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]. -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. #+begin_src emacs-lisp -(defun my-modus-themes-custom-faces () +(defun my-modus-themes-custom-faces (&rest _) (modus-themes-with-colors (custom-set-faces - ;; Replace green with blue if you use `modus-themes-deuteranopia'. - `(git-gutter-fr:added ((,class :foreground ,green-fringe-bg))) - `(git-gutter-fr:deleted ((,class :foreground ,red-fringe-bg))) - `(git-gutter-fr:modified ((,class :foreground ,yellow-fringe-bg)))))) + ;; Make foreground the same as background for a uniform bar on + ;; Doom Emacs. + ;; + ;; Doom should not be implementing such hacks because themes + ;; cannot support them: + ;; <https://protesilaos.com/codelog/2022-08-04-doom-git-gutter-modus-themes/>. + `(git-gutter-fr:added ((,c :foreground ,bg-added-fringe))) + `(git-gutter-fr:deleted ((,c :foreground ,bg-removed-fringe))) + `(git-gutter-fr:modified ((,c :foreground ,bg-changed-fringe)))))) (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) #+end_src +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + As always, re-load the theme for changes to take effect. If the above does not work, try this instead: @@ -4917,30 +4283,30 @@ If the above does not work, try this instead: (after! modus-themes (modus-themes-with-colors (custom-set-faces - ;; Replace green with blue if you use `modus-themes-deuteranopia'. - `(git-gutter-fr:added ((,class :foreground ,green-fringe-bg))) - `(git-gutter-fr:deleted ((,class :foreground ,red-fringe-bg))) - `(git-gutter-fr:modified ((,class :foreground ,yellow-fringe-bg)))))) + ;; Make foreground the same as background for a uniform bar on + ;; Doom Emacs. + ;; + ;; Doom should not be implementing such hacks because themes + ;; cannot support them: + ;; <https://protesilaos.com/codelog/2022-08-04-doom-git-gutter-modus-themes/>. + `(git-gutter-fr:added ((,c :foreground ,bg-added-intense))) + `(git-gutter-fr:deleted ((,c :foreground ,bg-removed-intense))) + `(git-gutter-fr:modified ((,c :foreground ,bg-changed-intense)))))) #+end_src -Replace ~green-fringe-bg~ with ~blue-fringe-bg~ if you want to optimize -for red-green color deficiency. - -[[#h:3ed03a48-20d8-4ce7-b214-0eb7e4c79abe][Option for red-green color deficiency or deuteranopia]]. - ** Note on php-mode multiline comments :PROPERTIES: :CUSTOM_ID: h:d0a3157b-9c04-46e8-8742-5fb2a7ae8798 :END: Depending on your build of Emacs and/or the environment it runs in, -multiline comments in PHP with the =php-mode= package use the +multiline comments in PHP with the ~php-mode~ package use the ~font-lock-doc-face~ instead of ~font-lock-comment-face~. This seems to make all comments use the appropriate face: #+begin_src emacs-lisp -(defun my-multine-comments () +(defun my-multine-comments (&rest _) (setq-local c-doc-face-name 'font-lock-comment-face)) (add-hook 'php-mode-hook #'my-multine-comments) @@ -5042,10 +4408,10 @@ elsewhere in this document. For example: #+begin_src emacs-lisp (modus-themes-with-colors (custom-set-faces - `(fill-column-indicator ((,class :foreground ,bg-active))))) + `(fill-column-indicator ((,c :foreground ,bg-active))))) #+end_src -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. To make the line thicker, set the height to be equal to the base font size instead of the one pixel we use. This is done by specifying a rate @@ -5055,7 +4421,7 @@ For example: #+begin_src emacs-lisp (modus-themes-with-colors (custom-set-faces - `(fill-column-indicator ((,class :height 1.0 :background ,bg-inactive :foreground ,bg-inactive))))) + `(fill-column-indicator ((,c :height 1.0 :background ,bg-inactive :foreground ,bg-inactive))))) #+end_src ** Note on highlight-parentheses.el @@ -5063,10 +4429,10 @@ For example: :CUSTOM_ID: h:24bab397-dcb2-421d-aa6e-ec5bd622b913 :END: -The =highlight-parentheses= package provides contextual coloration of +The ~highlight-parentheses~ package provides contextual coloration of surrounding parentheses, highlighting only those which are around the -point. The package expects users to customize the applicable colors on -their own by configuring certain variables. +point. The package expects users to customize the applicable colors +on their own by configuring certain variables. To make the Modus themes work as expected with this, we need to use some of the techniques that are discussed at length in the various @@ -5076,7 +4442,7 @@ advanced customization options of the themes. [[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]. In the following example, we are assuming that the user wants to (i) -reuse color variables provided by the themes, (ii) be able to retain +re-use color variables provided by the themes, (ii) be able to retain their tweaks while switching between ~modus-operandi~ and ~modus-vivendi~, and (iii) have the option to highlight either the foreground of the parentheses or the background as well. @@ -5096,7 +4462,7 @@ Then we can update our preference with this: (setq my-highlight-parentheses-use-background nil) #+end_src -To reuse colors from the themes, we must wrap our code in the +To re-use colors from the themes, we must wrap our code in the ~modus-themes-with-colors~ macro. Our implementation must interface with the variables ~highlight-parentheses-background-colors~ and/or ~highlight-parentheses-colors~. @@ -5113,14 +4479,14 @@ found): ;; Here we set color combinations that involve both a background ;; and a foreground value. - (setq highlight-parentheses-background-colors (list cyan-refine-bg - magenta-refine-bg - green-refine-bg - yellow-refine-bg) - highlight-parentheses-colors (list cyan-refine-fg - magenta-refine-fg - green-refine-fg - yellow-refine-fg)) + (setq highlight-parentheses-background-colors (list bg-cyan-intense + bg-magenta-intense + bg-green-intense + bg-yellow-intense) + highlight-parentheses-colors (list cyan + magenta + green + yellow)) ;; And here we pass only foreground colors while disabling any ;; backgrounds. @@ -5152,7 +4518,7 @@ implementation: (setq my-highlight-parentheses-use-background nil) ; Set to nil to disable backgrounds -(defun my-modus-themes-highlight-parentheses () +(defun my-modus-themes-highlight-parentheses (&rest _) (modus-themes-with-colors ;; Our preference for setting either background or foreground ;; styles, depending on `my-highlight-parentheses-use-background'. @@ -5160,14 +4526,14 @@ implementation: ;; Here we set color combinations that involve both a background ;; and a foreground value. - (setq highlight-parentheses-background-colors (list cyan-refine-bg - magenta-refine-bg - green-refine-bg - yellow-refine-bg) - highlight-parentheses-colors (list cyan-refine-fg - magenta-refine-fg - green-refine-fg - yellow-refine-fg)) + (setq highlight-parentheses-background-colors (list bg-cyan-intense + bg-magenta-intense + bg-green-intense + bg-yellow-intense) + highlight-parentheses-colors (list cyan + magenta + green + yellow)) ;; And here we pass only foreground colors while disabling any ;; backgrounds. @@ -5187,6 +4553,8 @@ implementation: (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-highlight-parentheses) #+end_src +[[#h:d87673fe-2ce1-4c80-a4b8-be36ca9f2d24][Using a hook at the post-load-theme phase]]. + As always, re-load the theme for changes to take effect. ** Note on mmm-mode.el background colors @@ -5221,7 +4589,7 @@ Users who might prefer to fall below the minimum 7:1 contrast ratio in relative luminance (the accessibility target we conform with), can opt to configure the relevant faces on their own. -[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +[[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. This example uses more vivid background colors, though it comes at the very high cost of degraded legibility. @@ -5229,14 +4597,14 @@ very high cost of degraded legibility. #+begin_src emacs-lisp (modus-themes-with-colors (custom-set-faces - `(mmm-cleanup-submode-face ((,class :background ,yellow-refine-bg))) - `(mmm-code-submode-face ((,class :background ,bg-active))) - `(mmm-comment-submode-face ((,class :background ,blue-refine-bg))) - `(mmm-declaration-submode-face ((,class :background ,cyan-refine-bg))) - `(mmm-default-submode-face ((,class :background ,bg-alt))) - `(mmm-init-submode-face ((,class :background ,magenta-refine-bg))) - `(mmm-output-submode-face ((,class :background ,red-refine-bg))) - `(mmm-special-submode-face ((,class :background ,green-refine-bg))))) + `(mmm-cleanup-submode-face ((,c :background ,bg-yellow-intense))) + `(mmm-code-submode-face ((,c :background ,bg-inactive))) + `(mmm-comment-submode-face ((,c :background ,bg-blue-intense))) + `(mmm-declaration-submode-face ((,c :background ,bg-cyan-intense))) + `(mmm-default-submode-face ((,c :background ,bg-dim))) + `(mmm-init-submode-face ((,c :background ,bg-magenta-intense))) + `(mmm-output-submode-face ((,c :background ,bg-red-intense))) + `(mmm-special-submode-face ((,c :background ,bg-green-intense))))) #+end_src ** Note on prism.el @@ -5250,13 +4618,14 @@ implements an alternative to the typical coloration of code. Instead of highlighting the syntactic constructs, it applies color to different levels of depth in the code structure. -As {{{file(prism.el)}}} offers a broad range of customizations, we cannot -style it directly at the theme level: that would run contrary to the -spirit of the package. Instead, we may offer preset color schemes. -Those should offer a starting point for users to adapt to their needs. +As {{{file(prism.el)}}} offers a broad range of customizations, we +cannot style it directly at the theme level: that would run contrary +to the spirit of the package. Instead, we may offer preset color +schemes. Those should offer a starting point for users to adapt to +their needs. In the following code snippets, we employ the ~modus-themes-with-colors~ -macro: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]. +macro: [[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Use theme colors in code with modus-themes-with-colors]]. These are the minimum recommended settings with 16 colors: @@ -5269,20 +4638,20 @@ These are the minimum recommended settings with 16 colors: :colors (modus-themes-with-colors (list fg-main magenta - cyan-alt-other - magenta-alt-other + cyan-cooler + magenta-cooler blue - magenta-alt - cyan-alt - red-alt-other + magenta-warmer + cyan-warmer + red-cooler green fg-main cyan yellow - blue-alt - red-alt - green-alt-other - fg-special-warm))) + blue-warmer + red-warmer + green-cooler + yellow-faint))) #+end_src With 8 colors: @@ -5296,11 +4665,11 @@ With 8 colors: :colors (modus-themes-with-colors (list blue magenta - magenta-alt-other - cyan-alt-other + magenta-cooler + cyan-cooler fg-main - blue-alt - red-alt-other + blue-warmer + red-cooler cyan))) #+end_src @@ -5316,8 +4685,8 @@ to the themes' default aesthetic: :colors (modus-themes-with-colors (list blue magenta - magenta-alt-other - green-alt))) + magenta-cooler + green-warmer))) #+end_src If you need to apply desaturation and lightening, you can use what the @@ -5330,47 +4699,11 @@ examples with the 4, 8, 16 colors): :lightens (cl-loop for i from 0 below 16 collect (* i 2.5)) :colors (modus-themes-with-colors (list fg-main - cyan-alt-other - magenta-alt-other + cyan-cooler + magenta-cooler magenta))) #+end_src -** Note on god-mode.el -:properties: -:alt_title: Note for god-mode -:custom_id: h:4da1d515-3e05-47ef-9e45-8251fc7e986a -:end: - -The ~god-mode~ library does not provide faces that could be configured by -the Modus themes. Users who would like to get some visual feedback on -the status of {{{kbd(M-x god-mode)}}} are instead encouraged by upstream to -set up their own configurations, such as by changing the ~mode-line~ face -([[#h:f4651d55-8c07-46aa-b52b-bed1e53463bb][Advanced customization]]). This is an adaptation of the approach -followed in the upstream README: - -#+begin_src emacs-lisp -(defun my-god-mode-update-mode-line () - "Make `mode-line' blue if God local mode is active." - (modus-themes-with-colors - (if god-local-mode - (set-face-attribute 'mode-line nil - :foreground blue-active - :background bg-active-accent - :box blue) - (set-face-attribute 'mode-line nil - :foreground fg-active - :background bg-active - :box fg-alt)))) - -(add-hook 'post-command-hook 'my-god-mode-update-mode-line) -#+end_src - -We employ the ~modus-themes-with-colors~ which provides access to color -variables defined by the active theme. Its use is covered elsewhere in -this manual ([[#h:51ba3547-b8c8-40d6-ba5a-4586477fd4ae][Face specs at scale using the themes' palette]]). As for the -attributes that can be passed to each face, start by consulting the -documentation string of ~set-face-attribute~. - ** Note on company-mode overlay pop-up :properties: :custom_id: h:20cef8c4-d11f-4053-8b2c-2872925780b1 @@ -5387,6 +4720,8 @@ instead of overlays.[fn:: https://github.com/company-mode/company-mode/issues/1010][fn:: https://github.com/tumashu/company-posframe/] +Also consider the ~corfu~ package. + ** Note on ERC escaped color sequences :properties: :custom_id: h:98bdf319-1e32-4469-8a01-771200fba65c @@ -5446,10 +4781,10 @@ Consult the doc string of ~shr-use-colors~. :end: #+cindex: Fonts in EWW, Elfeed, Ement, and SHR -By default, packages that build on top of the Simple HTML Remember (=shr=) -use proportionately spaced fonts. This is controlled by the user option -~shr-use-fonts~, which is set to non-~nil~ by default. To use the standard -font instead, set that variable to nil. +By default, packages that build on top of the Simple HTML Remember +(~shr~) use proportionately spaced fonts. This is controlled by the +user option ~shr-use-fonts~, which is set to non-~nil~ by default. To +use the standard font instead, set that variable to ~nil~. [[#h:defcf4fc-8fa8-4c29-b12e-7119582cc929][Font configurations for Org and others]]. @@ -5466,9 +4801,10 @@ This is a non-exhaustive list. :custom_id: h:8e636056-356c-4ca7-bc78-ebe61031f585 :end: -The =ement.el= library by Adam Porter (also known as "alphapapa") defaults -to a method of colorizing usernames in a rainbow style. This is -controlled by the user option ~ement-room-prism~ and can be disabled with: +The {{{file(ement.el)}}} library by Adam Porter (also known as +"alphapapa") defaults to a method of colorizing usernames in a rainbow +style. This is controlled by the user option ~ement-room-prism~ and +can be disabled with: #+begin_src emacs-lisp (setq ement-room-prism nil) @@ -5482,7 +4818,7 @@ slightly below our nominal target. Try this instead: (setq ement-room-prism-minimum-contrast 7) #+end_src -With regard to fonts, Ement depends on =shr= ([[#h:e6c5451f-6763-4be7-8fdb-b4706a422a4c][Note on SHR fonts]]). +With regard to fonts, Ement depends on ~shr~ ([[#h:e6c5451f-6763-4be7-8fdb-b4706a422a4c][Note on SHR fonts]]). Since we are here, here is an excerpt from Ement's source code: @@ -5500,38 +4836,6 @@ would be a good baseline for many themes and/or user configurations. Our target is the highest of the sort, though we do not demand that everyone conforms with it. -** Note on Helm grep -:properties: -:custom_id: h:d28879a2-8e4b-4525-986e-14c0f873d229 -:end: - -There is one face from the Helm package that is meant to highlight the -matches of a grep or grep-like command (=ag= or =ripgrep=). It is -~helm-grep-match~. However, this face can only apply when the user does -not pass =--color=always= as a command-line option for their command. - -Here is the docstring for that face, which is defined in the -{{{file(helm-grep.el)}}} library (you can always visit the source code with -{{{kbd(M-x find-library)}}}). - -#+begin_quote -Face used to highlight grep matches. Have no effect when grep backend -use "--color=" -#+end_quote - -The user must either remove =--color= from the flags passed to the grep -function, or explicitly use =--color=never= (or equivalent). Helm -provides user-facing customization options for controlling the grep -function's parameters, such as ~helm-grep-default-command~ and -~helm-grep-git-grep-command~. - -When =--color=always= is in effect, the grep output will use red text in -bold letter forms to present the matching part in the list of -candidates. That style still meets the contrast ratio target of >= 7:1 -(accessibility standard WCAG AAA), because it draws the reference to -ANSI color number 1 (red) from the already-supported array of -~ansi-color-names-vector~. - ** Note on pdf-tools link hints :properties: :custom_id: h:2659d13e-b1a5-416c-9a89-7c3ce3a76574 @@ -5603,7 +4907,7 @@ those buttons. Disabling the logo fixes the problem: The built-in ~goto-address-mode~ uses heuristics to identify URLs and email addresses in the current buffer. It then applies a face to them -to change their style. Some packages, such as =notmuch=, use this +to change their style. Some packages, such as ~notmuch~, use this minor-mode automatically. The faces are not declared with ~defface~, meaning that it is better @@ -5617,7 +4921,7 @@ consider including (or equivalent) this in their setup: goto-address-mail-mouse-face 'highlight) #+end_src -My personal preference is to set ~goto-address-mail-face~ to nil, as +My personal preference is to set ~goto-address-mail-face~ to ~nil~, as it otherwise adds too much visual noise to the buffer (email addresses stand out more, due to the use of the uncommon =@= character but also because they are often enclosed in angled brackets). @@ -5770,7 +5074,7 @@ more effective than trying to do the same with either red or blue (the latter is the least effective in that regard). When we need to work with several colors, it is always better to have -sufficient maneuvering space, especially since we cannot pick arbitrary +sufficient manoeuvring space, especially since we cannot pick arbitrary colors but only those that satisfy the accessibility objectives of the themes. @@ -5824,7 +5128,7 @@ each of the three channels of light (red, green, blue). For example: : xrandr --output LVDS1 --brightness 1.0 --gamma 0.76:0.75:0.68 Typography is another variable. Some font families are blurry at small -point sizes. Others may have a regular weight that is lighter (thinner) +point sizes. Others may have a regular weight that is lighter (thiner) than that of their peers which may, under certain circumstances, cause a halo effect around each glyph. @@ -5849,15 +5153,15 @@ A good theme is one that does so with consistency, though not uniformity. In practical terms, a color scheme is what one uses when, for example, -they edit the first sixteen escape sequences of a terminal emulator to -the hues of their preference. The terminal offers the option to choose, -say, the exact value of what counts as "red", but does not provide the -means to control where that is mapped to and whether it should also have -other qualities such as a bold weight for the underlying text or an -added background color. In contradistinction, Emacs uses constructs -known as "faces" which allow the user/developer to specify where a given -color will be used and whether it should be accompanied by other -typographic or stylistic attributes. +they replace the first sixteen escape sequences of a terminal emulator +with color values of their preference. The terminal offers the option +to choose, say, the exact value of what counts as "red", but does not +provide the means to control where that is mapped to and whether it +should also have other qualities such as a bold weight for the +underlying text or an added background color. In contradistinction, +Emacs uses constructs known as "faces" which allow the user/developer +to specify where a given color will be used and whether it should be +accompanied by other typographic or stylistic attributes. By configuring the multitude of faces on offer we thus control both which colors are applied and how they appear in their context. When a @@ -5876,9 +5180,7 @@ it is already understood that one must follow the indicator or headline to view its contents and (ii) underlining everything would make the interface virtually unusable. -[[#h:5808be52-361a-4d18-88fd-90129d206f9b][Option for links]]. - -Again, one must exercise judgment in order to avoid discrimination, +Again, one must exercise judgement in order to avoid discrimination, where "discrimination" refers to: + The treatment of substantially different magnitudes as if they were of @@ -5888,9 +5190,9 @@ where "discrimination" refers to: (To treat similar things differently; to treat dissimilar things alike.) -If, in other words, one was to enforce uniformity without accounting for -the particular requirements of each case---the contextual demands for -usability beyond matters of color---they would be making a +If, in other words, one is to enforce uniformity without accounting +for the particular requirements of each case---the contextual demands +for usability beyond matters of color---they are making a not-so-obvious error of treating different cases as if they were the same. @@ -5923,13 +5225,13 @@ doing so would run contrary to how this project is maintained where details matter greatly. Each program has its own requirements so it won't always be -possible---or indeed desirable---to have 1:1 correspondence between what -applies to Emacs and what should be done elsewhere. No port should ever -strive to be a faithful copy of the Emacs implementation, as no other -program is an Emacs equivalent, but instead try to follow the spirit of -the design. For example, some of the customization options accept a -list as their value, or an alist, which may not be possible to reproduce -on other platforms. +possible---or indeed desirable---to have 1:1 correspondence between +what applies to Emacs and what should be done elsewhere. No port +should ever strive to be a copy of the Emacs implementation, as no +other program is an Emacs equivalent, but instead try to follow the +spirit of the design. For example, some of the customization options +accept a list as their value, or an alist, which may not be possible +to reproduce on other platforms. [[#h:bf1c82f2-46c7-4eb2-ad00-dd11fdd8b53f][Customization options]]. @@ -5939,10 +5241,11 @@ standards are not compromised and (ii) the overall character of the themes remains consistent. The former criterion should be crystal clear as it pertains to the -scientific foundations of the themes: high legibility and taking care of -the needs of users with red-green color deficiency (deuteranopia) by -avoiding red+green color coding paradigms and/or by providing red+blue -variants. +scientific foundations of the themes: high legibility and taking care +of the needs of users with red-green/blue-yellow color deficiency +(deuteranopia and tritanopia) by avoiding red+green color coding +paradigms and/or by providing yellow+blue variants for deuteranopia +and red+cyan for tritanopia ([[#h:f0f3dbcb-602d-40cf-b918-8f929c441baf][Overview]]). The latter criterion is the "je ne sais quoi" of the artistic aspect of the themes, which is partially fleshed out in this manual. @@ -5951,7 +5254,7 @@ the themes, which is partially fleshed out in this manual. With regard to the artistic aspect (where "art" qua skill may amount to an imprecise science), there is no hard-and-fast rule in effect as it -requires one to exercise discretion and make decisions based on +requires one to exercize discretion and make decisions based on context-dependent information or constraints. As is true with most things in life, when in doubt, do not cling on to the letter of the law but try to understand its spirit. @@ -5980,13 +5283,17 @@ in which you can contribute to their ongoing development. :end: #+cindex: Sources of the themes -The ~modus-operandi~ and ~modus-vivendi~ themes are built into Emacs 28. - -The source code of the themes is [[https://git.sr.ht/~protesilaos/modus-themes][available on SourceHut]]. Or check the -[[https://gitlab.com/protesilaos/modus-themes/][GitLab mirror (former main source)]] and the [[https://github.com/protesilaos/modus-themes/][GitHub mirror]]. - -An HTML version of this manual is provided as an extension of the -[[https://protesilaos.com/emacs/modus-themes/][author's personal website]] (does not rely on any non-free code). ++ Package name (GNU ELPA): ~modus-themes~ ++ Official manual: <https://protesilaos.com/emacs/modus-themes> ++ Change log: <https://protesilaos.com/emacs/modus-themes-changelog> ++ Color palette: <https://protesilaos.com/emacs/modus-themes-colors> ++ Sample pictures: <https://protesilaos.com/emacs/modus-themes-pictures> ++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/modus-themes> + - Mirrors: + + GitHub: <https://github.com/protesilaos/modus-themes> + + GitLab: <https://gitlab.com/protesilaos/modus-themes> ++ Mailing list: <https://lists.sr.ht/~protesilaos/modus-themes> ++ Backronym: My Old Display Unexpectedly Sharpened ... themes ** Issues you can help with :properties: @@ -5994,10 +5301,8 @@ An HTML version of this manual is provided as an extension of the :end: #+cindex: Contributing -#+findex: modus-themes-report-bug A few tasks you can help with by sending an email to the general -[[https://lists.sr.ht/~protesilaos/modus-themes][modus-themes public mailing list]] (or use the command -~modus-themes-report-bug~). +[[https://lists.sr.ht/~protesilaos/modus-themes][modus-themes public mailing list]]. + Suggest refinements to packages that are covered. + Report packages not covered thus far. @@ -6014,10 +5319,6 @@ It is preferable that your feedback includes some screenshots, GIFs, or short videos, as well as further instructions to reproduce a given setup. Though this is not a requirement. -#+findex: modus-themes-version -Also consider mentioning the version of the themes you are using, such -as by invoking the command ~modus-themes-version~. - Whatever you do, bear in mind the overarching objective of the Modus themes: to keep a contrast ratio that is greater or equal to 7:1 between background and foreground colors. If a compromise is ever necessary @@ -6097,45 +5398,54 @@ The Modus themes are a collective effort. Every bit of work matters. + Author/maintainer :: Protesilaos Stavrou. -+ Contributions to code or documentation :: Alex Griffin, Anders - Johansson, Antonio Ruiz, Basil L.{{{space()}}} Contovounesios, Björn - Lindström, Carlo Zancanaro, Christian Tietze, Daniel Mendler, Eli - Zaretskii, Fritz Grabo, Illia Ostapyshyn, Kévin Le Gouguec, Koen van - Greevenbroek, Kostadin Ninev, Madhavan Krishnan, Manuel Giraud, - Markus Beppler, Matthew Stevenson, Mauro Aranda, Nicolas De - Jaeghere, Paul David, Philip Kaludercic, Pierre Téchoueyres, Rudolf - Adamkovič, Stephen Gildea, Shreyas Ragavan, Stefan Kangas, Utkarsh - Singh, Vincent Murphy, Xinglu Chen, Yuanchen Xie, okamsn. ++ Contributions to code or documentation :: Aleksei Gusev, Alex + Griffin, Anders Johansson, Antonio Ruiz, Basil L.{{{space()}}} + Contovounesios, Björn Lindström, Carlo Zancanaro, Christian Tietze, + Daniel Mendler, David Edmondson, Eli Zaretskii, Fritz Grabo, Gautier + Ponsinet, Illia Ostapyshyn, Kévin Le Gouguec, Koen van Greevenbroek, + Kostadin Ninev, Madhavan Krishnan, Manuel Giraud, Markus Beppler, + Matthew Stevenson, Mauro Aranda, Nacho Barrientos, Niall Dooley, + Nicolas De Jaeghere, Paul David, Philip Kaludercic, Pierre + Téchoueyres, Rudolf Adamkovič, Sergey Nichiporchik, Shreyas Ragavan, + Stefan Kangas, Stephen Berman, Stephen Gildea, Steve Downey, Tomasz + Hołubowicz, Utkarsh Singh, Vincent Murphy, Xinglu Chen, Yuanchen + Xie, fluentpwn, okamsn. + Ideas and user feedback :: Aaron Jensen, Adam Porter, Adam Spiers, - Adrian Manea, Alex Griffin, Alex Koen, Alex Peitsinis, Alexey - Shmalko, Alok Singh, Anders Johansson, André Alexandre Gomes, Andrew - Tropin, Antonio Hernández Blas, Arif Rezai, Augusto Stoffel, Basil - L.{{{space()}}} Contovounesios, Burgess Chang, Christian Tietze, + Adrian Manea, Aleksei Pirogov, Alex Griffin, Alex Koen, Alex + Peitsinis, Alexey Shmalko, Alok Singh, Anders Johansson, André + Alexandre Gomes, Andrew Tropin, Antonio Hernández Blas, Arif Rezai, + Augusto Stoffel, Basil L.{{{space()}}} Contovounesios, Bernd + Rellermeyer, Burgess Chang, Charlotte Van Petegem, Christian Tietze, Christopher Dimech, Christopher League, Damien Cassou, Daniel Mendler, Dario Gjorgjevski, David Edmondson, Davor Rotim, Divan Santana, Eliraz Kedmi, Emanuele Michele Alberto Monterosso, Farasha Euker, Feng Shu, Gautier Ponsinet, Gerry Agbobada, Gianluca Recchia, Gonçalo Marrafa, Guilherme Semente, Gustavo Barros, Hörmetjan - Yiltiz, Ilja Kocken, Iris Garcia, Ivan Popovych, Jeremy Friesen, - Jerry Zhang, Johannes Grødem, John Haman, Jonas Collberg, Jorge - Morais, Joshua O'Connor, Julio C. Villasante, Kenta Usami, Kevin - Fleming, Kévin Le Gouguec, Kevin Kainan Li, Kostadin Ninev, Len - Trigg, Lennart C. Karssen, Luis Miguel Castañeda, Magne Hov, Manuel - Uberti, Mark Bestley, Mark Burton, Mark Simpson, Markus Beppler, - Matt Armstrong, Matthias Fuchs, Mauro Aranda, Maxime Tréca, Michael - Goldenberg, Morgan Smith, Morgan Willcock, Murilo Pereira, Nicky van - Foreest, Nicolas De Jaeghere, Pablo Stafforini, Paul Poloskov, - Pengji Zhang, Pete Kazmier, Peter Wu, Philip Kaludercic, Pierre - Téchoueyres, Przemysław Kryger, Robert Hepple, Roman Rudakov, Ryan - Phillips, Rytis Paškauskas, Rudolf Adamkovič, Sam Kleinman, Samuel - Culpepper, Saša Janiška, Shreyas Ragavan, Simon Pugnet, Tassilo - Horn, Thibaut Verron, Thomas Heartman, Togan Muftuoglu, Tony Zorman, - Trey Merkley, Tomasz Hołubowicz, Toon Claes, Uri Sharf, Utkarsh - Singh, Vincent Foley. As well as users: Ben, CsBigDataHub1, Emacs - Contrib, Eugene, Fourchaux, Fredrik, Moesasji, Nick, Summer Emacs, - TheBlob42, Trey, bepolymathe, bit9tream, derek-upham, doolio, - fleimgruber, gitrj95, iSeeU, jixiuf, okamsn, pRot0ta1p. + Yiltiz, Ilja Kocken, Imran Khan, Iris Garcia, Ivan Popovych, James + Ferguson, Jeremy Friesen, Jerry Zhang, Johannes Grødem, John Haman, + John Wick, Jonas Collberg, Jorge Morais, Joshua O'Connor, Julio C. + Villasante, Kenta Usami, Kevin Fleming, Kévin Le Gouguec, Kevin + Kainan Li, Kostadin Ninev, Laith Bahodi, Lasse Lindner, Len Trigg, + Lennart C.{{{space()}}} Karssen, Luis Miguel Castañeda, Magne Hov, Manuel Giraud, + Manuel Uberti, Mark Bestley, Mark Burton, Mark Simpson, Marko Kocic, + Markus Beppler, Matt Armstrong, Matthias Fuchs, Mattias Engdegård, + Mauro Aranda, Maxime Tréca, Michael Goldenberg, Morgan Smith, Morgan + Willcock, Murilo Pereira, Nicky van Foreest, Nicolas De Jaeghere, + Nicolas Semrau, Olaf Meeuwissen, Oliver Epper, Pablo Stafforini, + Paul Poloskov, Pengji Zhang, Pete Kazmier, Peter Wu, Philip + Kaludercic, Pierre Téchoueyres, Przemysław Kryger, Robert Hepple, + Roman Rudakov, Russell Sim, Ryan Phillips, Rytis Paškauskas, Rudolf + Adamkovič, Sam Kleinman, Samuel Culpepper, Saša Janiška, Shreyas + Ragavan, Simon Pugnet, Steve Downey, Tassilo Horn, Thanos Apollo, + Thibaut Verron, Thomas Heartman, Togan Muftuoglu, Tony Zorman, Trey + Merkley, Tomasz Hołubowicz, Toon Claes, Uri Sharf, Utkarsh Singh, + Vincent Foley, Zoltan Kiraly. As well as users: Ben, CsBigDataHub1, + Emacs Contrib, Eugene, Fourchaux, Fredrik, Moesasji, Nick, Summer + Emacs, TheBlob42, TitusMu, Trey, bepolymathe, bit9tream, + bangedorrunt, derek-upham, doolio, fleimgruber, gitrj95, iSeeU, + jixiuf, ltmsyvag, okamsn, pRot0ta1p, soaringbird, tumashu, + wakamenod. + Packaging :: Basil L.{{{space()}}} Contovounesios, Eli Zaretskii, Glenn Morris, Mauro Aranda, Richard Stallman, Stefan Kangas (core @@ -6153,42 +5463,6 @@ themes' design and/or aspects of their functionality. All errors are my own. -* Other notes about the project -:properties: -:custom_id: h:13752581-4378-478c-af17-165b6e76bc1b -:end: -#+cindex: Development notes - -If you are curious about the principles that govern the development of -this project read the essay [[https://protesilaos.com/codelog/2020-03-17-design-modus-themes-emacs/][On the design of the Modus themes]] -(2020-03-17). - -Here are some more publications for those interested in the kind of work -that goes into this project (sometimes the commits also include details -of this sort): - -+ [[https://protesilaos.com/codelog/2020-05-10-modus-operandi-palette-review/][Modus Operandi theme subtle palette review]] (2020-05-10) -+ [[https://protesilaos.com/codelog/2020-06-13-modus-vivendi-palette-review/][Modus Vivendi theme subtle palette review]] (2020-06-13) -+ [[https://protesilaos.com/codelog/2020-07-04-modus-themes-faint-colours/][Modus themes: new "faint syntax" option]] (2020-07-04) -+ [[https://protesilaos.com/codelog/2020-07-08-modus-themes-nuanced-colours/][Modus themes: major review of "nuanced" colours]] (2020-07-08) -+ [[https://protesilaos.com/codelog/2020-09-14-modus-themes-review-blues/][Modus themes: review of blue colours]] (2020-09-14) -+ [[https://protesilaos.com/codelog/2020-12-27-modus-themes-review-rainbow-delimiters/][Modus themes: review rainbow-delimiters faces]] (2020-12-27) -+ [[https://protesilaos.com/codelog/2021-01-11-modus-themes-review-select-faint-colours/][Modus themes: review of select "faint" colours]] (2021-01-11) -+ [[https://protesilaos.com/codelog/2021-02-25-modus-themes-diffs-deuteranopia/][The Modus themes now cover deuteranopia in diffs]] (2021-02-25) -+ [[https://protesilaos.com/codelog/2021-06-02-modus-themes-org-agenda/][Introducing the variable modus-themes-org-agenda]] (2021-06-02) -+ [[https://protesilaos.com/codelog/2022-01-02-review-modus-themes-org-habit-colours/][Modus themes: review of the org-habit graph colours]] (2022-01-02) -+ [[https://protesilaos.com/codelog/2022-01-03-modus-themes-port-faq/][Re: VSCode or Vim ports of the Emacs modus-themes?]] (2022-01-03) -+ [[https://protesilaos.com/codelog/2022-04-20-modus-themes-case-study-avy/][Modus themes: case study on Avy faces and colour combinations]] (2022-04-20) -+ [[https://protesilaos.com/codelog/2022-04-21-modus-themes-colour-theory/][Emacs: colour theory and techniques used in the Modus themes]] (2022-04-21) - -And here are the canonical sources of this project: - -+ Manual :: <https://protesilaos.com/emacs/modus-themes> -+ Change Log :: <https://protesilaos.com/emacs/modus-themes-changelog> -+ Screenshots :: <https://protesilaos.com/emacs/modus-themes-pictures> -+ Git repository :: https://git.sr.ht/~protesilaos/modus-themes -+ Mailing list :: https://lists.sr.ht/~protesilaos/modus-themes - * GNU Free Documentation License :properties: :appendix: t |