\input texinfo @c -*- texinfo -*- @c %**start of header @setfilename ../../info/modus-themes.info @settitle Modus themes for GNU Emacs @include docstyle.texi @documentencoding UTF-8 @documentlanguage en @c %**end of header @include emacsver.texi @dircategory Emacs misc features @direntry * Modus Themes: (modus-themes). Highly accessible themes (WCAG AAA). @end direntry @finalout @titlepage @title Modus themes for GNU Emacs @author Protesilaos Stavrou (@email{info@@protesilaos.com}) @end titlepage @ifnottex @node Top @top Modus themes for GNU Emacs This manual, written by Protesilaos Stavrou, describes the customization options for the @samp{modus-operandi} and @samp{modus-vivendi} themes, and provides every other piece of information pertinent to them. The documentation furnished herein corresponds to version 1.0.2, released on 2020-12-06. Any reference to a newer feature which does not yet form part of the latest tagged commit, is explicitly marked as such. Copyright (C) 2020 Free Software Foundation, Inc. @quotation Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. @end quotation @end ifnottex @menu * Overview:: * Installation:: * Enable and load:: * Customization Options:: * Advanced customization (do-it-yourself):: * Face coverage:: * Notes for individual packages:: * Contributing:: * Acknowledgements:: * Meta:: * External projects (ports):: * GNU Free Documentation License:: @detailmenu --- The Detailed Node Listing --- Overview * How do the themes look like:: * Learn about the latest changes:: Installation * Install from the archives:: * Install on GNU/Linux:: Install on GNU/Linux * Debian 11 Bullseye:: * GNU Guix:: Enable and load * Load automatically:: * Toggle between the themes on demand:: * Configure options prior to loading a theme:: * Sample configuration for use-package:: Customization Options * Bold constructs:: Toggle bold constructs in code * Slanted constructs:: Toggle slanted constructs (italics) in code * Syntax styles:: Choose the overall aesthetic of code syntax * No mixed fonts:: Toggle mixing of font families * Link styles:: Choose link color intensity for the text or underline, or no underline at all * Command prompts:: Choose among plain, subtle, or intense prompts * Mode line:: Choose among plain, three-dimensional, or Moody-compliant styles * Completion UIs:: Choose among standard, moderate, or opinionated looks * Fringes:: Choose among invisible, subtle, or intense fringe visibility * Line highlighting:: Toggle intense style for current line highlighting * Matching parentheses:: Choose between various styles for matching delimiters/parentheses * Active region:: Choose between various styles for the active region * Diffs:: Choose among intense, desaturated, or text-only diffs * Org mode blocks:: Choose among plain, grayscale, or rainbow styles * Heading styles:: Choose among several styles, also per heading level * Scaled headings:: Toggle scaling of headings * Headings' font:: Toggle proportionately spaced fonts in headings Scaled headings * Scaled heading sizes:: Specify rate of increase for scaled headings Advanced customization (do-it-yourself) * Tweak faces (DIY):: Declare your own face specs * Font configs (DIY):: Optimise for mixed typeface buffers * Org user faces (DIY):: Extend styles for org-mode keywords and priorities * WCAG test (DIY):: Apply the WCAG formula to color values of your choosing * Load at time (DIY):: Switch between the themes depending on the time of day Face coverage * Supported packages:: Full list of covered face groups * Indirectly covered packages:: Notes for individual packages * Note on company-mode overlay pop-up:: * Note for ERC escaped color sequences:: * Note for powerline or spaceline:: * Note on SHR colors:: * Note for Helm grep:: * Note on vc-annotate-background-mode:: Contributing * Sources of the themes:: * Issues you can help with:: * Merge requests:: Legal considerations for code patches @end detailmenu @end menu @node Overview @chapter Overview 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 (@samp{modus-operandi}) is a light theme, while Modus Vivendi (@samp{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. To ensure that users have a consistently accessible experience, the themes strive to achieve as close to full face coverage as possible (see @xref{Face coverage}). Starting with version 0.12.0 and onwards, the themes are built into GNU Emacs. @menu * How do the themes look like:: * Learn about the latest changes:: @end menu @node How do the themes look like @section How do the themes look like Check the web page with @uref{https://protesilaos.com/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. @xref{Customization Options}. @node Learn about the latest changes @section Learn about the latest changes Please refer to the @uref{https://protesilaos.com/modus-themes-changelog, web page with the change log}. It is comprehensive and covers everything that goes into every tagged release of the themes. @node Installation @chapter Installation The Modus themes are distributed with Emacs starting with version 28.1. 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. @menu * Install from the archives:: * Install on GNU/Linux:: @end menu @node Install from the archives @section Install from the archives The @samp{modus-themes} package is available from the GNU ELPA archive, which is configured by default. Prior to querying any package archive, make sure to have updated the index, with @kbd{M-x package-refresh-contents}. Then all you need to do is type @kbd{M-x package-install} and specify the @samp{modus-themes}. Note that older versions of the themes used to be distributed as standalone packages. This practice has been discontinued starting with version 1.0.0 of this project. @node Install on GNU/Linux @section Install on GNU/Linux The themes are also available from the archives of some distributions of GNU/Linux. These should correspond to a tagged release rather than building directly from the latest Git commit. It all depends on the distro's packaging policies. @menu * Debian 11 Bullseye:: * GNU Guix:: @end menu @node Debian 11 Bullseye @subsection Debian 11 Bullseye The two themes are distributed as a single package for Debian and its derivatives. Currently in the unstable and testing suites and should be available in time for Debian 11 Bullseye (next stable). Get them with: @example sudo apt install elpa-modus-themes @end example @node GNU Guix @subsection GNU Guix Users of Guix can get the themes with this command: @example guix package -i emacs-modus-themes @end example @node Enable and load @chapter Enable and load This section documents how to load the theme of your choice and how to further control its initialization. It also includes some sample code snippets that could help you in the task. Before you load a theme, it is necessary to enable the libraries: @lisp (require 'modus-themes) ; common code (require 'modus-operandi-theme) ; light theme (require 'modus-vivendi-theme) ; dark theme @end lisp @ref{Sample configuration for use-package}. @menu * Load automatically:: * Toggle between the themes on demand:: * Configure options prior to loading a theme:: * Sample configuration for use-package:: @end menu @node Load automatically @section Load automatically Once the libraries that define the themes are enabled, you can load a theme with either of the following expressions: @lisp (load-theme 'modus-operandi t) ; Light theme (load-theme 'modus-vivendi t) ; Dark theme @end lisp Make sure to remove any other theme that is being loaded, otherwise you might run into unexpected issues. Note that you can always @kbd{M-x disable-theme} and specify an item. The command does exactly what its name suggests. To deactivate all enabled themes at once, in case you have multiple of them enabled, you may evaluate the following expression: @lisp (mapc #'disable-theme custom-enabled-themes) @end lisp @node Toggle between the themes on demand @section Toggle between the themes on demand The themes provide the @samp{modus-themes-toggle} command that you can bind to a key of your preference. For example: @lisp (global-set-key (kbd "") #'modus-themes-toggle) @end lisp What this toggle does is check if either @samp{modus-operandi} or @samp{modus-vivendi} is active and proceeds to cycle between them. If none of them are active, a minibuffer prompt will ask the user to choose between the two. In this latter scenario, all other themes will first be disabled (using the @samp{disable-theme} we covered before). Lastly, the toggle calls @samp{modus-themes-after-load-theme-hook} which you can use to add your tweaks (see @xref{Tweak faces (DIY)}). @node Configure options prior to loading a theme @section Configure options prior to loading a theme The themes provide a unified customization framework. This is why you need @samp{(require 'modus-themes)}. All options must be set before loading each theme in order to come into effect. For example: @lisp ;; Set customization options to values of your choice (setq modus-themes-slanted-constructs t modus-themes-bold-constructs nil modus-themes-fringes nil ; @{nil,'subtle,'intense@} modus-themes-mode-line '3d ; @{nil,'3d,'moody@} modus-themes-syntax nil ; Lots of options---continue reading the manual modus-themes-intense-hl-line nil modus-themes-paren-match 'subtle-bold ; @{nil,'subtle-bold,'intense,'intense-bold@} modus-themes-links 'neutral-underline ; Lots of options---continue reading the manual modus-themes-no-mixed-fonts nil modus-themes-prompts nil ; @{nil,'subtle,'intense@} modus-themes-completions nil ; @{nil,'moderate,'opinionated@} modus-themes-region 'bg-only-no-extend ; @{nil,'no-extend,'bg-only,'bg-only-no-extend@} modus-themes-diffs nil ; @{nil,'desaturated,'fg-only,'bg-only@} modus-themes-org-blocks nil ; @{nil,'grayscale,'rainbow@} modus-themes-headings ; Lots of options---continue reading the manual '((1 . section) (2 . section-no-bold) (3 . rainbow-line) (t . rainbow-line-no-bold)) modus-themes-variable-pitch-headings nil modus-themes-scale-headings nil modus-themes-scale-1 1.1 modus-themes-scale-2 1.15 modus-themes-scale-3 1.21 modus-themes-scale-4 1.27 modus-themes-scale-5 1.33) ;; Load the light theme (`modus-operandi') (modus-themes-load-operandi) ;; ;; Or load via a hook ;; (add-hook 'after-init-hook #'modus-themes-load-operandi) @end lisp Note that in this example we use @samp{modus-themes-load-operandi}. Here is what it does: @lisp (defun modus-themes-load-operandi () "Load `modus-operandi' and disable `modus-vivendi'. Also run `modus-themes-after-load-theme-hook'." (disable-theme 'modus-vivendi) (load-theme 'modus-operandi t) (run-hooks 'modus-themes-after-load-theme-hook)) @end lisp Same principle, inverse effect, for @samp{modus-themes-load-vivendi}. If you prefer to maintain different customization options between the two themes, it is best you write your own functions that first set those options and then load the themes. The following code does exactly that by simply differentiating the two themes on the choice of bold constructs in code syntax (enabled for one, disabled for the other). @lisp (defun my-demo-modus-operandi () (interactive) (setq modus-themes-bold-constructs t) ; ENABLE bold (modus-themes-load-operandi)) (defun my-demo-modus-vivendi () (interactive) (setq modus-themes-bold-constructs nil) ; DISABLE bold (modus-themes-load-vivendi)) (defun my-demo-modus-themes-toggle () (if (eq (car custom-enabled-themes) 'modus-operandi) (my-demo-modus-vivendi) (my-demo-modus-operandi))) @end lisp Then assign @samp{my-demo-modus-themes-toggle} to a key instead of the equivalent the themes provide. @node Sample configuration for use-package @section Sample configuration for use-package It is common for Emacs users to rely on @samp{use-package} for declaring package configurations in their setup. We use this as an example: @lisp (use-package modus-themes :ensure :init ;; Add all your customizations prior to loading the themes (setq modus-themes-slanted-constructs t modus-themes-bold-constructs nil) :config ;; Load the theme of your choice (modus-themes-load-operandi) ;; ;; OR ;; (load-theme 'modus-operandi t) :bind ("" . modus-themes-toggle)) @end lisp Note that manual installations expect that the user byte compiles all the relevant files and creates autoloads for them. If, for whatever reason, users wish to install the theme files manually while not doing the requisite packaging work, then this code block must be used instead (but please prefer the packaged format that does proper byte compilation and autoloading). The following snippet is for manual installations or those that use the themes that are shipped with Emacs: @lisp (use-package modus-themes :ensure :init ;; Add all your customizations prior to loading the themes (setq modus-themes-slanted-constructs t modus-themes-bold-constructs nil) ;; Enable the theme files (use-package modus-operandi-theme) (use-package modus-vivendi-theme) :config ;; Load the theme of your choice (modus-themes-load-operandi) :bind ("" . modus-themes-toggle)) @end lisp @node Customization Options @chapter Customization Options The Modus themes are highly configurable, though they should work well without any further tweaks. By default, all customization options are set to @samp{nil}. Remember that all customization options must be evaluated before loading a theme (see @xref{Enable and load}). @menu * Bold constructs:: Toggle bold constructs in code * Slanted constructs:: Toggle slanted constructs (italics) in code * Syntax styles:: Choose the overall aesthetic of code syntax * No mixed fonts:: Toggle mixing of font families * Link styles:: Choose link color intensity for the text or underline, or no underline at all * Command prompts:: Choose among plain, subtle, or intense prompts * Mode line:: Choose among plain, three-dimensional, or Moody-compliant styles * Completion UIs:: Choose among standard, moderate, or opinionated looks * Fringes:: Choose among invisible, subtle, or intense fringe visibility * Line highlighting:: Toggle intense style for current line highlighting * Matching parentheses:: Choose between various styles for matching delimiters/parentheses * Active region:: Choose between various styles for the active region * Diffs:: Choose among intense, desaturated, or text-only diffs * Org mode blocks:: Choose among plain, grayscale, or rainbow styles * Heading styles:: Choose among several styles, also per heading level * Scaled headings:: Toggle scaling of headings * Headings' font:: Toggle proportionately spaced fonts in headings @end menu @node Bold constructs @section Option for more bold constructs Symbol: @samp{modus-themes-bold-constructs} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate The default is to use a bold typographic weight only when it is required. With a non-nil value (@samp{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 prompts. @node Slanted constructs @section Option for more slanted constructs Symbol: @samp{modus-themes-slanted-constructs} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate The default is to not use slanted text (italics) unless it is absolutely necessary. With a non-nil value (@samp{t}) choose to render more faces in slanted text. This typically affects documentation strings and code comments. @node Syntax styles @section Option for syntax highlighting Symbol: @samp{modus-themes-syntax} Possible values: @enumerate @item @samp{nil} (default) @item @samp{faint} @item @samp{yellow-comments} @item @samp{green-strings} @item @samp{yellow-comments-green-strings} @item @samp{alt-syntax} @item @samp{alt-syntax-yellow-comments} @end enumerate The default style (nil) for code syntax highlighting is a balanced combination of colors on the cyan-blue-magenta side of the spectrum. There is little to no use of greens, yellows, or reds, except when it is necessary. Option @samp{faint} is like the default in terms of the choice of palette but applies desaturated color values. Option @samp{yellow-comments} applies a yellow tint to comments. The rest of the syntax is the same as the default. Option @samp{green-strings} replaces the blue/cyan/cold color variants in strings with greener alternatives. The rest of the syntax remains the same. Option @samp{yellow-comments-green-strings} combines yellow comments with green strings and the rest of the default syntax highlighting style. Option @samp{alt-syntax} expands the active spectrum by applying color combinations with more contrasting hues between them. Expect to find more red and green variants in addition to cyan, blue, magenta. Option @samp{alt-syntax-yellow-comments} combines @samp{alt-syntax} with @samp{yellow-comments}. @node No mixed fonts @section Option for no font mixing Symbol: @samp{modus-themes-no-mixed-fonts} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate By default, the themes configure some spacing-sensitive faces, such as Org tables and code blocks, to always inherit from the @samp{fixed-pitch} face. This is to ensure that those constructs remain monospaced when users opt for something like the built-in @kbd{M-x variable-pitch-mode}. Otherwise the layout would appear broken. To disable this behaviour, set the option to @samp{t}. 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 @samp{org-variable-pitch} and @samp{mixed-pitch}. @xref{Font configs (DIY)}. @node Link styles @section Option for links Symbol: @samp{modus-themes-links} Possible values: @enumerate @item @samp{nil} (default) @item @samp{faint} @item @samp{neutral-underline} @item @samp{faint-neutral-underline} @item @samp{no-underline} @end enumerate The default style (nil) for links is to apply an underline and a saturated color to the affected text. The color of the two is the same, which makes the link fairly prominent. Option @samp{faint} follows the same approach as the default, but uses less intense colors. Option @samp{neutral-underline} changes the underline's color to a subtle gray, while retaining the default text color. Option @samp{faint-neutral-underline} combines a desaturated text color with a subtle gray underline. Option @samp{no-underline} removes link underlines altogether, while keeping their text color the same as the default. @node Command prompts @section Option for command prompt styles Symbol: @samp{modus-themes-prompts} Possible values: @enumerate @item @samp{nil} (default) @item @samp{subtle} @item @samp{intense} @end enumerate The default does not use any background for minibuffer and command line prompts. It relies exclusively on an accented foreground color. The options @samp{subtle} and @samp{intense} apply a combination of accented background and foreground to such prompts. The difference between the two is that the latter has a more pronounced/noticeable effect than the former. @node Mode line @section Option for mode line presentation Symbol: @samp{modus-themes-mode-line} Possible values: @enumerate @item @samp{nil} (default) @item @samp{3d} @item @samp{moody} @end enumerate The default produces a two-dimensional effect both for the active and inactive modelines. The differences between the two are limited to distinct shades of grayscale values, with the active being more intense than the inactive. Option @samp{3d} will make the active modeline look like a three-dimensional rectangle. Inactive modelines remain 2D, though they are slightly toned down relative to the default. This aesthetic is virtually the same as what you get when you run Emacs without any customizations (@kbd{emacs -Q} on the command line). While @samp{moody} removes all box effects from the modelines and applies underline and overline properties instead. It also tones down a bit the inactive modelines. This is meant to optimize things for use with the @uref{https://github.com/tarsius/moody, moody package} (hereinafter referred to as ``Moody''), though it can work fine even without it. 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 @samp{moody} option, which will come into effect when the background of the modeline changes to something less accessible, such as Moody ribbons (read the doc string of @samp{set-face-attribute}, specifically @samp{: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 effect, users would need to experiment with the variable @samp{face-near-same-color-threshold} to trigger the effect. We find that a value of @samp{45000} will suffice, contrary to the default @samp{30000}. Do not set the value too high, because that would have the adverse effect of always overriding the default color (which has been carefully designed to be highly accessible). Furthermore, because Moody expects an underline and overline instead of a box style, it is advised you include this in your setup: @lisp (setq x-underline-at-descent-line t) @end lisp @node Completion UIs @section Option for completion framework aesthetics Symbol: @samp{modus-themes-completions} Possible values: @enumerate @item @samp{nil} (default) @item @samp{moderate} @item @samp{opinionated} @end enumerate This is a special option that has different effects depending on the completion UI@. The interfaces can be grouped in two categories, based on their default aesthetics: (i) those that only or mostly use foreground colors for their interaction model, and (ii) those that combine background and foreground values for some of their metaphors. The former category encompasses Icomplete, Ido, Selectrum as well as pattern matching styles like Orderless and Flx. The latter covers Helm, Ivy, and similar. A value of @samp{nil} will respect the metaphors of each completion framework. Option @samp{moderate} applies a combination of background and foreground that is fairly subtle. For Icomplete and friends this constitutes a departure from their default aesthetics, however the difference is small. While Helm, Ivy et al appear slightly different than their original looks, as they are toned down a bit. Option @samp{opinionated} uses color combinations that refashion the completion UI@. For the Icomplete camp this means that intense background and foreground combinations are used: in effect their looks emulate those of Helm, Ivy and co. in their original style. Whereas the other group of packages will revert to an even more nuanced aesthetic with some additional changes to the choice of hues. To appreciate the scope of this customization option, you should spend some time with every one of the @samp{nil} (default), @samp{moderate}, and @samp{opinionated} possibilities. @node Fringes @section Option for fringe visibility Symbol: @samp{modus-themes-fringes} Possible values: @enumerate @item @samp{nil} (default) @item @samp{subtle} @item @samp{intense} @end enumerate The default is to use the same color as that of the main background, meaning that the fringes are not obvious though they still occupy the space given to them by @samp{fringe-mode}. Options @samp{subtle} and @samp{intense} apply a gray background, making the fringes visible. The difference between the two is one of degree, as their names imply. @node Line highlighting @section Option for line highlighting (hl-line-mode) Symbol: @samp{modus-themes-intense-hl-line} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate The default is to use a subtle gray background for @samp{hl-line-mode} and its global equivalent. With a non-nil value (@samp{t}) use a more prominent background color instead. This affects several packages that enable @samp{hl-line-mode}, such as @samp{elfeed} and @samp{mu4e}. @node Matching parentheses @section Option for parenthesis matching (show-paren-mode) Symbol: @samp{modus-themes-paren-match} Possible values: @enumerate @item @samp{nil} (default) @item @samp{subtle-bold} @item @samp{intense} @item @samp{intense-bold} @end enumerate Nil means to use a subtle tinted background color for the matching delimiters. Option @samp{intense} applies a saturated background color. Option @samp{subtle-bold} is the same as the default, but also makes use of bold typographic weight (inherits the @samp{bold} face). Option @samp{intense-bold} is the same as @samp{intense}, while it also uses a bold weight. This customization variable affects tools such as the built-in @samp{show-paren-mode} and @samp{smartparens}. @node Active region @section Option for active region Symbol: @samp{modus-themes-region} Possible values: @enumerate @item @samp{nil} (default) @item @samp{no-extend} @item @samp{bg-only} @item @samp{bg-only-no-extend} @end enumerate Nil means to only use a prominent gray background with a neutral foreground. The foreground overrides all syntax highlighting. The region extends to the edge of the window. Option @samp{no-extend} preserves the default aesthetic but prevents the region from extending to the edge of the window. Option @samp{bg-only} applies a faint tinted background that is distinct from all others used in the theme, while it does not override any existing colors. It extends to the edge of the window. Option @samp{bg-only-no-extend} is a combination of the @samp{bg-only} and @samp{no-extend} options. @node Diffs @section Option for diff buffer looks Symbol: @samp{modus-themes-diffs} Possible values: @enumerate @item @samp{nil} (default) @item @samp{desaturated} @item @samp{fg-only} @end enumerate By default the themes apply rich coloration to the output of diffs, such as those of @samp{diff-mode}, @samp{ediff}, @samp{smerge-mode}, and @samp{magit}. These are color combinations of an accented background and foreground so that, for example, added lines have a pronounced green background with an appropriate shade of green for the affected text. Word-wise or ``refined'' changes follow this pattern but use different shades of those colors to remain distinct. Option @samp{desaturated} tones down all relevant color values. It still combines an accented background with an appropriate foreground, yet its overall impression is fairly subtle. Refined changes are a bit more intense to fulfil their intended function, though still less saturated than default. Option @samp{fg-only} will remove most accented backgrounds and instead rely on color-coded text to denote changes. For instance, added lines use a green foreground, while their background is the same as the rest of the buffer. Word-wise highlights still use a background value which is, nonetheless, more subtle than its default equivalent. Option @samp{bg-only} applies color-coded backgrounds but does not override any syntax highlighting that may be present. This makes it suitable for use with a non-nil value for @samp{diff-font-lock-syntax} (which is the default for @samp{diff-mode} buffers in Emacs 27 or higher). Concerning Magit, an extra set of tweaks are introduced for the effect of highlighting the current diff hunk, so as to remain aligned with the overall experience of that mode. Expect changes that are consistent with the overall intent of the aforementioned. Note, however, that the @samp{bg-only} option will not deliver the intended results in Magit diffs because no syntax highlighting is used there (last checked with Magit version 20201116.1057, though upstream has a plan to eventually support such a feature---this entry shall be updated accordingly). @node Org mode blocks @section Option for org-mode block styles Symbol: @samp{modus-themes-org-blocks} Possible values: @enumerate @item @samp{nil} (default) @item @samp{grayscale} @item @samp{rainbow} @end enumerate The default is to use the same background as the rest of the buffer for the contents of the block. Option @samp{grayscale} applies a subtle neutral gray background to the block's contents. It will also extend to the edge of the window the background of the ``begin'' and ``end'' block delimiter lines (only relevant for Emacs versions >= 27 where the 'extend' keyword is part of the face specifications). Option @samp{rainbow} uses an accented background for the contents of the block. The exact color will depend on the programming language and is controlled by the @samp{org-src-block-faces} variable. This is most suitable for users who work on literate programming documents that mix and match several languages. Note that the ``rainbow'' blocks may require you to also reload the major-mode so that the colors are applied properly: use @kbd{M-x org-mode} or @kbd{M-x org-mode-restart} to refresh the buffer. Or start typing in each code block (inefficient at scale, but it still works). @node Heading styles @section Option for the headings' overall style This is defined as an alist and, therefore, uses a different approach than other customization options documented in this manual. Symbol: @samp{modus-themes-headings} Possible values, which can be specified for each heading level (examples further below): @itemize @item nil (default fallback option---covers all heading levels) @item @samp{t} (default style for a single heading, when the fallback differs) @item @samp{no-bold} @item @samp{line} @item @samp{line-no-bold} @item @samp{rainbow} @item @samp{rainbow-line} @item @samp{rainbow-line-no-bold} @item @samp{highlight} @item @samp{highlight-no-bold} @item @samp{rainbow-highlight} @item @samp{rainbow-highlight-no-bold} @item @samp{section} @item @samp{section-no-bold} @item @samp{rainbow-section} @item @samp{rainbow-section-no-bold} @end itemize To control faces per level from 1-8, use something like this: @lisp (setq modus-themes-headings '((1 . section) (2 . section-no-bold) (3 . rainbow-line) (t . rainbow-line-no-bold))) @end lisp The above uses the @samp{section} value for heading levels 1, @samp{section-no-bold} for headings 2, @samp{rainbow-line} for 3. All other levels fall back to @samp{rainbow-line-no-bold}. To set a uniform value for all heading levels, use this pattern: @lisp ;; A given style for every heading (setq modus-themes-headings '((t . section))) ;; Default aesthetic for every heading (setq modus-themes-headings '()) @end lisp The default style for headings uses a fairly desaturated foreground value in combination with bold typographic weight. To specify this style for a given level N, assuming you wish to have another fallback option, just specify the value @samp{t} like this: @lisp (setq modus-themes-headings '((1 . t) (2 . line) (t . rainbow-line-no-bold))) @end lisp A description of all other possible styles beyond the default: @itemize @item @samp{no-bold} retains the default text color while removing the bold typographic weight. @item @samp{line} is the same as the default plus an overline across the heading's length. @item @samp{line-no-bold} is the same as @samp{line} without bold weight. @item @samp{rainbow} uses a more colorful foreground in combination with bold typographic weight. @item @samp{rainbow-line} is the same as @samp{rainbow} plus an overline. @item @samp{rainbow-line-no-bold} is the same as @samp{rainbow-line} without the bold weight. @item @samp{highlight} retains the default style of a fairly desaturated foreground combined with a bold weight and adds to it a subtle accented background. @item @samp{highlight-no-bold} is the same as @samp{highlight} without a bold weight. @item @samp{rainbow-highlight} is the same as @samp{highlight} but with a more colorful foreground. @item @samp{rainbow-highlight-no-bold} is the same as @samp{rainbow-highlight} without a bold weight. @item @samp{section} retains the default looks and adds to them both an overline and a slightly accented background. It is, in effect, a combination of the @samp{line} and @samp{highlight} values. @item @samp{section-no-bold} is the same as @samp{section} without a bold weight. @item @samp{rainbow-section} is the same as @samp{section} but with a more colorful foreground. @item @samp{rainbow-section-no-bold} is the same as @samp{rainbow-section} without a bold weight. @end itemize @node Scaled headings @section Option for scaled headings Symbol: @samp{modus-themes-scale-headings} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate The default is to use the same size for headings and paragraph text. With a non-nil value (@samp{t}) make headings larger in height relative to the main text. This is noticeable in modes like Org. @menu * Scaled heading sizes:: Specify rate of increase for scaled headings @end menu @node Scaled heading sizes @subsection Control the scale of headings In addition to toggles for enabling scaled headings, users can also specify a number of their own. @itemize @item If it is a floating point, say, @samp{1.5}, it is interpreted as a multiple of the base font size. This is the recommended method. @item If it is an integer, it is read as an absolute font height. The number is basically the point size multiplied by ten. So if you want it to be @samp{18pt} you must pass @samp{180}. Please understand that setting an absolute value is discouraged, as it will break the layout when you try to change font sizes with the built-in @samp{text-scale-adjust} command (see @xref{Font configs (DIY)}). @end itemize Below are the variables in their default values, using the floating point paradigm. The numbers are very conservative, but you are free to change them to your liking, such as @samp{1.2}, @samp{1.4}, @samp{1.6}, @samp{1.8}, @samp{2.0}---or use a resource for finding a consistent scale: @lisp (setq modus-themes-scale-1 1.05 modus-themes-scale-2 1.1 modus-themes-scale-3 1.15 modus-themes-scale-4 1.2 modus-themes-scale-5 1.3) @end lisp Note that in earlier versions of Org, scaling would only increase the size of the heading, but not of keywords that were added to it, like ``TODO''. The issue has been fixed upstream: @uref{https://protesilaos.com/codelog/2020-09-24-org-headings-adapt/}. @node Headings' font @section Option for variable-pitch font in headings Symbol: @samp{modus-themes-variable-pitch-headings} Possible values: @enumerate @item @samp{nil} (default) @item @samp{t} @end enumerate The default is to use the main font family, which typically is monospaced. With a non-nil value (@samp{t}) apply a proportionately spaced typeface, else ``variable-pitch'', to headings (such as in Org mode). @xref{Font configs (DIY)}. @node Advanced customization (do-it-yourself) @chapter Advanced customization (do-it-yourself) 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 (see @xref{Customization Options}). 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 labelled as ``do-it-yourself'' or ``DIY''. @menu * Tweak faces (DIY):: Declare your own face specs * Font configs (DIY):: Optimise for mixed typeface buffers * Org user faces (DIY):: Extend styles for org-mode keywords and priorities * WCAG test (DIY):: Apply the WCAG formula to color values of your choosing * Load at time (DIY):: Switch between the themes depending on the time of day @end menu @node Tweak faces (DIY) @section Custom face specs using the themes' palette (DIY) 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. @xref{Toggle between the themes on demand}. @xref{Configure options prior to loading}. Now assume you wish to change a single face, say, the @samp{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 @samp{modus-themes-color} function. It accepts a symbol that is associated with a color in @samp{modus-themes-colors-operandi} and @samp{modus-themes-colors-vivendi}. Like this: @lisp (modus-themes-color 'blue) @end lisp The function always extracts the color value of the active Modus theme. @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' @end lisp Do @samp{C-h v} on the aforementioned variables to check all the available symbols that can be passed to this function. With that granted, let us expand the example to actually change the @samp{cursor} face's background property. We employ the built-in function of @samp{set-face-attribute}: @lisp (set-face-attribute 'cursor nil :background (modus-themes-color 'blue)) @end lisp If you evaluate this form, your cursor will become blue. But if you change themes, such as with @samp{modus-themes-toggle}, your edits will be lost, because the newly loaded theme will override the @samp{:background} attribute you had assigned to that face. For such changes to persist, we need to make them after loading the theme. So we rely on @samp{modus-themes-after-load-theme-hook}, which gets called from @samp{modus-themes-load-operandi}, @samp{modus-themes-load-vivendi}, as well as the command @samp{modus-themes-toggle}. Here is a sample function that tweaks two faces and then gets added to the hook: @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))) (add-hook 'modus-themes-after-load-theme-hook #'my-modus-themes-custom-faces) @end lisp 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 @samp{bold} face. For example: @lisp (set-face-attribute 'bold nil :weight 'semibold) @end lisp 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 @samp{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 @samp{modus-themes-colors-operandi} and @samp{modus-themes-colors-vivendi}, only here you pass the two keys you want, first for @samp{modus-operandi} then @samp{modus-vivendi}. Take the previous example with the @samp{cursor} face: @lisp ;; Blue for `modus-operandi' and red for `modus-vivendi' (set-face-attribute 'cursor nil :background (modus-themes-color-alts 'blue 'red)) @end lisp @printindex cp @node Font configs (DIY) @section Font configurations for Org and others (DIY) The themes are designed to cope well with mixed font configurations (@xref{No mixed fonts}). This mostly concerns @samp{org-mode} and @samp{markdown-mode}, though expect to find it elsewhere like in @samp{Info-mode}. In practice it means that the user can safely opt for a more prose-friendly proportionately spaced typeface as their default, while letting spacing-sensitive elements like tables and inline code always use a monospaced font, by inheriting from the @samp{fixed-pitch} face. Users can try the built-in @kbd{M-x variable-pitch-mode} to see the effect in action. To make everything use your desired font families, you need to configure the @samp{variable-pitch} (proportional spacing) and @samp{fixed-pitch} (monospaced) faces respectively. It may also be convenient to set your main typeface by configuring the @samp{default} face the same way. Put something like this in your initialization file (also consider reading the doc string of @samp{set-face-attribute}): @lisp ;; Main typeface (set-face-attribute 'default nil :family "DejaVu Sans Mono" :height 110) ;; Proportionately spaced typeface (set-face-attribute 'variable-pitch nil :family "DejaVu Serif" :height 1.0) ;; Monospaced typeface (set-face-attribute 'fixed-pitch nil :family "DejaVu Sans Mono" :height 1.0) @end lisp Note the differences in the @samp{:height} property. The @samp{default} face must specify an absolute value, which is the point size × 10. So if you want to use a font at point size @samp{11}, you set the height to @samp{110}.@footnote{@samp{:height} values do not need to be rounded to multiples of ten: the likes of @samp{115} are perfectly valid—some typefaces will change to account for those finer increments.} Whereas every other face must have a value that is relative to the default, represented as a floating point (if you use an integer, then that means an absolute height). This is of paramount importance: it ensures that all fonts can scale gracefully when using something like the @samp{text-scale-adjust} command which only operates on the base font size (i.e. the @samp{default} face's absolute height). @printindex cp @node Org user faces (DIY) @section Org user faces (DIY) Users of @samp{org-mode} have the option to configure various keywords and priority cookies to better match their workflow. User options are @samp{org-todo-keyword-faces} and @samp{org-priority-faces}. As those are meant to be custom faces, it is futile to have the themes guess what each user wants to use, which keywords to target, and so on. Instead, we can provide guidelines on how to customize things to one's liking with the intent of retaining the overall aesthetic of the themes. Please bear in mind that the end result of those is not controlled by the active Modus theme but by how Org maps faces to its constructs. Editing those while @kbd{org-mode} is active requires @kbd{M-x org-mode-restart} for changes to take effect. Let us assume you wish to visually differentiate your keywords. You have something like this: @lisp (setq org-todo-keywords '((sequence "TODO(t)" "|" "DONE(D)" "CANCEL(C)") (sequence "MEET(m)" "|" "MET(M)") (sequence "STUDY(s)" "|" "STUDIED(S)") (sequence "WRITE(w)" "|" "WROTE(W)"))) @end lisp 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 @samp{org-todo} face: @lisp (setq org-todo-keyword-faces '(("MEET" . '(font-lock-preprocessor-face org-todo)) ("STUDY" . '(font-lock-variable-name-face org-todo)) ("WRITE" . '(font-lock-type-face org-todo)))) @end lisp This will refashion the keywords you specify, while letting the other items in @samp{org-todo-keywords} use their original styles (which are defined in the @samp{org-todo} and @samp{org-done} faces). If you want back the defaults, try specifying just the @samp{org-todo} face: @lisp (setq org-todo-keyword-faces '(("MEET" . org-todo) ("STUDY" . org-todo) ("WRITE" . org-todo))) @end lisp When you inherit from multiple faces, you need to quote the list as shown further above. The order is important: the last item is applied over the previous ones. If you do not want to blend multiple faces, you do not need a quoted list. A pattern of @samp{keyword . face} will suffice. Both approaches can be used simultaneously, as illustrated in this configuration of the priority cookies: @lisp (setq org-priority-faces '((?A . '(org-scheduled-today org-priority)) (?B . org-priority) (?C . '(shadow org-priority)))) @end lisp To find all the faces that are loaded in your current Emacs session, use @kbd{M-x list-faces-display}. Also try @kbd{M-x describe-variable} and then specify the name of each of those Org variables demonstrated above. 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. @xref{Tweak faces (DIY)}. @xref{WCAG test (DIY)}. @printindex cp @node WCAG test (DIY) @section Check color combinations (DIY) The themes provide the functions @samp{modus-themes-wcag-formula} and @samp{modus-themes-contrast}. The former is a direct implementation of the WCAG formula: @uref{https://www.w3.org/TR/WCAG20-TECHS/G18.html}. It gives you the relative luminance of a color value that is expressed in hexadecimal RGB notation. While the latter function is just a convenient wrapper for comparing the luminance of two colors. In practice, you only likely need @samp{modus-themes-contrast}. It accepts two color values and returns their contrast ratio. Values range from 1 to 21 (lowest to highest). The themes are designed to always be equal or higher than 7 for each combination of background and foreground that they use (this is the WCAG AAA standard---the most demanding of its kind). A couple of examples (rounded numbers): @lisp ;; Pure white with pure green (modus-themes-contrast "#ffffff" "#00ff00") ;; => 1.37 ;; That is an outright inaccessible combo ;; Pure black with pure green (modus-themes-contrast "#000000" "#00ff00") ;; => 15.3 ;; That is is a highly accessible combo @end lisp It does not matter which color value comes first. The ratio is always the same. If you do not wish to read all the decimal points, you can try something like this: @lisp (format "%0.2f" (modus-themes-contrast "#000000" "#00ff00")) @end lisp Bear in mind that the themes define an expanded palette in large part because certain colors are only meant to be used in combination with some others. Consult the source code for relevant commentary. And use the resources we covered in this section in case you plan to derive your own color combinations. @printindex cp @node Load at time (DIY) @section Load theme depending on time of day While we do provide @samp{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 @samp{solar.el} and then configuring the @samp{circadian} library: @lisp (use-package solar ; built-in :config (setq calendar-latitude 35.17 calendar-longitude 33.36)) (use-package circadian ; you need to install this :ensure :after solar (setq circadian-themes '((:sunrise . modus-operandi) (:sunset . modus-vivendi))) (circadian-setup)) @end lisp @printindex cp @printindex cp @node Face coverage @chapter Face coverage The Modus themes try to provide as close to full face coverage as possible. This is necessary to ensure a consistently accessible reading experience across all available interfaces. @menu * Supported packages:: Full list of covered face groups * Indirectly covered packages:: @end menu @node Supported packages @section Full support for packages or face groups This list will always be updated to reflect the current state of the project. The idea is to offer an overview of the known status of all affected face groups. The items with an appended asterisk @samp{*} tend to have lots of extensions, so the ``full support'' may not be 100% true… @itemize @item ace-window @item ag @item alert @item all-the-icons @item annotate @item anzu @item apropos @item apt-sources-list @item artbollocks-mode @item auctex and @TeX{} @item auto-dim-other-buffers @item avy @item awesome-tray @item binder @item bm @item bongo @item boon @item breakpoint (provided by the built-in @samp{gdb-mi.el} library) @item buffer-expose @item calendar and diary @item calfw @item centaur-tabs @item change-log and log-view (such as @samp{vc-print-log} and @samp{vc-print-root-log}) @item cider @item circe @item color-rg @item column-enforce-mode @item company-mode* @item company-posframe @item compilation-mode @item completions @item consult @item counsel* @item counsel-css @item counsel-notmuch @item counsel-org-capture-string @item cov @item cperl-mode @item csv-mode @item ctrlf @item custom (@kbd{M-x customize}) @item dap-mode @item dashboard (emacs-dashboard) @item deadgrep @item debbugs @item define-word @item deft @item dictionary @item diff-hl @item diff-mode @item dim-autoload @item dir-treeview @item dired @item dired-async @item dired-git @item dired-git-info @item dired-narrow @item dired-subtree @item diredfl @item disk-usage @item doom-modeline @item dynamic-ruler @item easy-jekyll @item easy-kill @item ebdb @item ediff @item eglot @item el-search @item eldoc-box @item elfeed @item elfeed-score @item emms @item enhanced-ruby-mode @item epa @item equake @item erc @item eros @item ert @item eshell @item eshell-fringe-status @item eshell-git-prompt @item eshell-prompt-extras (epe) @item eshell-syntax-highlighting @item evil* (evil-mode) @item evil-goggles @item evil-visual-mark-mode @item eww @item eyebrowse @item fancy-dabbrev @item flycheck @item flycheck-color-mode-line @item flycheck-indicator @item flycheck-posframe @item flymake @item flyspell @item flyspell-correct @item flx @item freeze-it @item frog-menu @item focus @item fold-this @item font-lock (generic syntax highlighting) @item forge @item fountain (fountain-mode) @item geiser @item git-commit @item git-gutter (and variants) @item git-lens @item git-rebase @item git-timemachine @item git-walktree @item gnus @item golden-ratio-scroll-screen @item helm* @item helm-ls-git @item helm-switch-shell @item helm-xref @item helpful @item highlight-blocks @item highlight-defined @item highlight-escape-sequences (@samp{hes-mode}) @item highlight-indentation @item highlight-numbers @item highlight-symbol @item highlight-tail @item highlight-thing @item hl-defined @item hl-fill-column @item hl-line-mode @item hl-todo @item hydra @item hyperlist @item ibuffer @item icomplete @item icomplete-vertical @item ido-mode @item iedit @item iflipb @item imenu-list @item indium @item info @item info-colors @item interaction-log @item ioccur @item isearch, occur, etc. @item ivy* @item ivy-posframe @item jira (org-jira) @item journalctl-mode @item js2-mode @item julia @item jupyter @item kaocha-runner @item keycast @item line numbers (@samp{display-line-numbers-mode} and global variant) @item lsp-mode @item lsp-ui @item macrostep @item magit @item magit-imerge @item make-mode @item man @item markdown-mode @item markup-faces (@samp{adoc-mode}) @item mentor @item messages @item minibuffer-line @item minimap @item modeline @item mood-line @item moody @item mpdel @item mu4e @item mu4e-conversation @item multiple-cursors @item neotree @item no-emoji @item notmuch @item num3-mode @item nxml-mode @item objed @item orderless @item org* @item org-journal @item org-noter @item org-pomodoro @item org-recur @item org-roam @item org-superstar @item org-table-sticky-header @item org-treescope @item origami @item outline-mode @item outline-minor-faces @item package (@kbd{M-x list-packages}) @item page-break-lines @item paradox @item paren-face @item parrot @item pass @item pdf-tools @item persp-mode @item perspective @item phi-grep @item phi-search @item pkgbuild-mode @item pomidor @item popup @item powerline @item powerline-evil @item proced @item prodigy @item racket-mode @item rainbow-blocks @item rainbow-identifiers @item rainbow-delimiters @item rcirc @item regexp-builder (also known as @samp{re-builder}) @item rg (rg.el) @item ripgrep @item rmail @item ruler-mode @item sallet @item selectrum @item semantic @item sesman @item shell-script-mode @item show-paren-mode @item shr @item side-notes @item sieve-mode @item skewer-mode @item smart-mode-line @item smartparens @item smerge @item spaceline @item speedbar @item spell-fu @item stripes @item suggest @item switch-window @item swiper @item swoop @item sx @item symbol-overlay @item syslog-mode @item table (built-in table.el) @item telephone-line @item term @item tomatinho @item transient (pop-up windows such as Magit's) @item trashed @item treemacs @item tty-menu @item tuareg @item typescript @item undo-tree @item vc (built-in mode line status for version control) @item vc-annotate (@samp{C-x v g}) @item vdiff @item vimish-fold @item visible-mark @item visual-regexp @item volatile-highlights @item vterm @item wcheck-mode @item web-mode @item wgrep @item which-function-mode @item which-key @item whitespace-mode @item window-divider-mode @item winum @item writegood-mode @item woman @item xah-elisp-mode @item xref @item xterm-color (and ansi-colors) @item yaml-mode @item yasnippet @item ztree @end itemize Plus many other miscellaneous faces that are provided by the upstream GNU Emacs distribution. @node Indirectly covered packages @section Indirectly covered packages These do not require any extra styles because they are configured to inherit from some basic faces. Please confirm. @itemize @item bbdb @item edit-indirect @item evil-owl @item fortran-mode @item i3wm-config-mode @item perl-mode @item php-mode @item rjsx-mode @item swift-mode @end itemize @node Notes for individual packages @chapter Notes for individual packages This section covers information that may be of interest to users of individual packages. @menu * Note on company-mode overlay pop-up:: * Note for ERC escaped color sequences:: * Note for powerline or spaceline:: * Note on SHR colors:: * Note for Helm grep:: * Note on vc-annotate-background-mode:: @end menu @node Note on company-mode overlay pop-up @section Note on company-mode overlay pop-up By default, the @samp{company-mode} pop-up that lists completion candidates is drawn using an overlay. This creates alignment issues every time it is placed above a piece of text that has a different height than the default. The solution recommended by the project's maintainer is to use an alternative front-end for drawing the pop-up which draws child frames instead of overlays.@footnote{@uref{https://github.com/company-mode/company-mode/issues/1010}}@footnote{@uref{https://github.com/tumashu/company-posframe/}} @node Note for ERC escaped color sequences @section Note for ERC escaped color sequences The built-in IRC client @samp{erc} has the ability to colorise any text using escape sequences that start with @samp{^C} (inserted with @samp{C-q C-c}) and are followed by a number for the foreground and background.@footnote{This page explains the basics, though it is not specific to Emacs: @uref{https://www.mirc.com/colors.html}} Possible numbers are 0-15, with the first entry being the foreground and the second the background, separated by a comma. Like this @samp{^C1,6}. The minimum setup is this: @lisp (add-to-list 'erc-modules 'irccontrols) (setq erc-interpret-controls-p t erc-interpret-mirc-color t) @end lisp As this allows users the chance to make arbitrary combinations, it is impossible to guarantee a consistently high contrast ratio. All we can we do is provide guidance on the combinations that satisfy the accessibility standard of the themes: @table @asis @item Modus Operandi Use foreground color 1 for all backgrounds from 2-15. Like so: @samp{C-q C-c1,N} where @samp{N} is the background. @item Modus Vivendi Use foreground color 0 for all backgrounds from 2-13. Use foreground @samp{1} for backgrounds 14, 15. @end table Colors 0 and 1 are white and black respectively. So combine them together, if you must. @node Note for powerline or spaceline @section Note for powerline or spaceline Both Powerline and Spaceline package users will likely need to use the command @samp{powerline-reset} whenever they make changes to their themes and/or modeline setup. @node Note on SHR colors @section Note on SHR colors Emacs' HTML rendering library (@samp{shr.el}) may need explicit configuration to respect the theme's colors instead of whatever specifications the webpage provides. Consult @samp{C-h v shr-use-colors}. @node Note for Helm grep @section Note for Helm grep There is one face from the Helm package that is meant to highlight the matches of a grep or grep-like command (@samp{ag} or @samp{ripgrep}). It is @samp{helm-grep-match}. However, this face can only apply when the user does not pass @samp{--color=always} as a command-line option for their command. Here is the docstring for that face, which is defined in the @samp{helm-grep.el} library (view a library with @kbd{M-x find-library}). @quotation Face used to highlight grep matches. Have no effect when grep backend use ``--color='' @end quotation The user must either remove @samp{--color} from the flags passed to the grep function, or explicitly use @samp{--color=never} (or equivalent). Helm provides user-facing customization options for controlling the grep function's parameters, such as @samp{helm-grep-default-command} and @samp{helm-grep-git-grep-command}. When @samp{--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 @samp{ansi-color-names-vector}. @node Note on vc-annotate-background-mode @section Note on vc-annotate-background-mode Due to the unique way @samp{vc-annotate} (@samp{C-x v g}) applies colors, support for its background mode (@samp{vc-annotate-background-mode}) is disabled at the theme level. Normally, such a drastic measure should not belong in a theme: assuming the user's preferences is bad practice. However, it has been deemed necessary in the interest of preserving color contrast accessibility while still supporting a useful built-in tool. If there actually is a way to avoid such a course of action, without prejudice to the accessibility standard of this project, then please report as much or send patches (see @xref{Contributing}). @node Contributing @chapter Contributing This section documents the canonical sources of the themes and the ways in which you can contribute to their ongoing development. @menu * Sources of the themes:: * Issues you can help with:: * Merge requests:: Legal considerations for code patches @end menu @node Sources of the themes @section Sources of the themes The @samp{modus-operandi} and @samp{modus-vivendi} themes are built into Emacs. Currently they are in the project's @samp{master} branch, which is tracking the next development release target. The source code of the themes is @uref{https://gitlab.com/protesilaos/modus-themes/, available on Gitlab}, for the time being. A @uref{https://github.com/protesilaos/modus-themes/, mirror on Github} is also on offer. An HTML version of this manual is provided as an extension of the @uref{https://protesilaos.com/modus-themes/, author's personal website} (does not rely on any non-free code). @node Issues you can help with @section Issues you can help with A few tasks you can help with: @itemize @item Suggest refinements to packages that are covered. @item Report packages not covered thus far. @item Report bugs, inconsistencies, shortcomings. @item Help expand the documentation of covered-but-not-styled packages. @item Suggest refinements to the color palette. @item Help expand this document or any other piece of documentation. @item Merge requests for code refinements. @end itemize @xref{Merge requests}. 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. 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 between aesthetics and accessibility, it shall always be made in the interest of the latter. @node Merge requests @section Patches require copyright assignment to the FSF Code contributions are most welcome. For any major edit (more than 15 lines, or so, in aggregate per person), you need to make a copyright assignment to the Free Software Foundation. This is necessary because the themes are part of the upstream Emacs distribution: the FSF must at all times be in a position to enforce the GNU General Public License. Copyright assignment is a simple process. Check the request form below (please adapt it accordingly). You must write an email to the address mentioned in the form and then wait for the FSF to send you a legal agreement. Sign the document and file it back to them. This could all happen via email and take about a week. You are encouraged to go through this process. You only need to do it once. It will allow you to make contributions to Emacs in general. @example Please email the following information to assign@@gnu.org, and we will send you the assignment form for your past and future changes. Please use your full legal name (in ASCII characters) as the subject line of the message. ---------------------------------------------------------------------- REQUEST: SEND FORM FOR PAST AND FUTURE CHANGES [What is the name of the program or package you're contributing to?] GNU Emacs [Did you copy any files or text written by someone else in these changes? Even if that material is free software, we need to know about it.] Copied a few snippets from the same files I edited. Their author, Protesilaos Stavrou, has already assigned copyright to the Free Software Foundation. [Do you have an employer who might have a basis to claim to own your changes? Do you attend a school which might make such a claim?] [For the copyright registration, what country are you a citizen of?] [What year were you born?] [Please write your email address here.] [Please write your postal address here.] [Which files have you changed so far, and which new files have you written so far?] @end example @node Acknowledgements @chapter Acknowledgements The Modus themes are a collective effort. Every bit of work matters. @table @asis @item Author/maintainer Protesilaos Stavrou. @item Contributions to code or documentation Anders Johansson, Basil L@. Contovounesios, Eli Zaretskii, Madhavan Krishnan, Markus Beppler, Matthew Stevenson, Shreyas Ragavan, Stefan Kangas, Vincent Murphy. @item Ideas and user feedback Aaron Jensen, Adam Spiers, Alex Griffin, Alex Peitsinis, Alexey Shmalko, Alok Singh, Anders Johansson, André Alexandre Gomes, Arif Rezai, Basil L@. Contovounesios, Damien Cassou, Daniel Mendler, Dario Gjorgjevski, David Edmondson, Davor Rotim, Divan Santana, Gerry Agbobada, Gianluca Recchia, Hörmetjan Yiltiz, Ilja Kocken, Iris Garcia, Jeremy Friesen, John Haman, Len Trigg, Manuel Uberti, Mark Burton, Markus Beppler, Michael Goldenberg, Murilo Pereira, Nicolas De Jaeghere, Paul Poloskov, Pete Kazmier, Pierre Téchoueyres, Roman Rudakov, Ryan Phillips, Shreyas Ragavan, Simon Pugnet, Tassilo Horn, Thibaut Verron, Trey Merkley, Togan Muftuoglu, Uri Sharf, Utkarsh Singh, Vincent Foley. As well as users: Ben, Emacs Contrib, Eugene, Fourchaux, Fredrik, Moesasji, Nick, TheBlob42, bepolymathe, dinko, doolio, fleimgruber, iSeeU, jixiuf, okamsn, tycho garen. @item Packaging Dhavan Vaidya (Debian), Stefan Kangas (core Emacs), Stefan Monnier (GNU Elpa). @item Inspiration for certain features Bozhidar Batsov (zenburn-theme), Fabrice Niessen (leuven-theme). @end table Special thanks, in no particular order, to Manuel Uberti and Omar Antolín Camarena for their long time contributions and insightful commentary. @node Meta @chapter Meta If you are curious about the principles that govern the development of this project read the essay @uref{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): @itemize @item @uref{https://protesilaos.com/codelog/2020-05-10-modus-operandi-palette-review/, Modus Operandi theme subtle palette review} (2020-05-10) @item @uref{https://protesilaos.com/codelog/2020-06-13-modus-vivendi-palette-review/, Modus Vivendi theme subtle palette review} (2020-06-13) @item @uref{https://protesilaos.com/codelog/2020-07-04-modus-themes-faint-colours/, Modus themes: new ``faint syntax'' option} (2020-07-04) @item @uref{https://protesilaos.com/codelog/2020-07-08-modus-themes-nuanced-colours/, Modus themes: major review of ``nuanced'' colours} (2020-07-08) @item @uref{https://protesilaos.com/codelog/2020-09-14-modus-themes-review-blues/, Modus themes: review of blue colours} (2020-09-14) @end itemize And here are the canonical sources of this project's documentation: @table @asis @item Manual @uref{https://protesilaos.com/modus-themes} @item Change Log @uref{https://protesilaos.com/modus-themes-changelog} @item Screenshots @uref{https://protesilaos.com/modus-themes-pictures} @end table @node External projects (ports) @chapter External projects (ports) The present section documents projects that extend the scope of the Modus themes. The following list will be updated whenever relevant information is brought to my attention. If you already have or intend to produce such a port, feel welcome @uref{https://protesilaos.com/contact, to contact me}. @table @asis @item Modus exporter This is @uref{https://github.com/polaris64/modus-exporter, an Elisp library written by Simon Pugnet}. Licensed under the terms of the GNU General Public License. It is meant to capture the color values of the active Modus theme (Operandi or Vivendi) and output it as a valid theme for some other application. @end table @node GNU Free Documentation License @appendix GNU Free Documentation License @example GNU Free Documentation License Version 1.3, 3 November 2008 Copyright (C) 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 0. PREAMBLE The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others. This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software. We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference. 1. APPLICABILITY AND DEFINITIONS This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law. A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language. A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them. The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none. The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words. A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque". Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only. The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text. The "publisher" means any person or entity that distributes copies of the Document to the public. A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition. The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License. 2. VERBATIM COPYING You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3. You may also lend copies, under the same conditions stated above, and you may publicly display copies. 3. COPYING IN QUANTITY If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects. If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages. If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public. It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document. 4. MODIFICATIONS You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version: A. Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission. B. List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement. C. State on the Title page the name of the publisher of the Modified Version, as the publisher. D. Preserve all the copyright notices of the Document. E. Add an appropriate copyright notice for your modifications adjacent to the other copyright notices. F. Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below. G. Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document's license notice. H. Include an unaltered copy of this License. I. Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence. J. Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission. K. For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein. L. Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles. M. Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version. N. Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section. O. Preserve any Warranty Disclaimers. If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles. You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties--for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard. You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one. The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version. 5. COMBINING DOCUMENTS You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers. The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work. In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements". 6. COLLECTIONS OF DOCUMENTS You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects. You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document. 7. AGGREGATION WITH INDEPENDENT WORKS A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document. If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate. 8. TRANSLATION Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail. If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title. 9. TERMINATION You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License. However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it. 10. FUTURE REVISIONS OF THIS LICENSE The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/. Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Document. 11. RELICENSING "Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A "Massive Multiauthor Collaboration" (or "MMC") contained in the site means any set of copyrightable works thus published on the MMC site. "CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization. "Incorporate" means to publish or republish a Document, in whole or in part, as part of another Document. An MMC is "eligible for relicensing" if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008. The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing. ADDENDUM: How to use this License for your documents To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page: Copyright (c) YEAR YOUR NAME. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with...Texts." line with this: with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation. If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software. @end example @bye