Next: About the Standard themes [Index]
Copyright (C) 2022-2023 Free Software Foundation, Inc.
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 the Front-Cover Texts being “A GNU Manual,” and with the Back-Cover Texts as in (a) below. A copy of the license is included in the section entitled “GNU Free Documentation License.”
(a) The FSF’s Back-Cover Text is: “You have the freedom to copy and modify this GNU manual.”
This manual, written by Protesilaos Stavrou, describes the Emacs package
called standard-themes, and provides every other piece of information
pertinent to it.
The documentation furnished herein corresponds to stable version 2.1.0, released on 2024-08-11. 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 2.2.0-dev.
standard-themes
If you are viewing the README.org version of this file, please note that the GNU ELPA machinery automatically generates an Info manual out of it.
Next: Installation, Previous: standard-themes: Like the default theme but more consistent, Up: standard-themes: Like the default theme but more consistent [Index]
The standard-themes are a pair of light and dark themes for GNU
Emacs. They emulate the out-of-the-box looks of Emacs (which
technically do NOT constitute a theme) while bringing to them thematic
consistency, customizability, and extensibility.
Next: Sample configuration, Previous: About the Standard themes, Up: standard-themes: Like the default theme but more consistent [Index]
Next: Manual installation, Up: Installation [Index]
The package is available as standard-themes. Simply do:
M-x package-refresh-contents M-x package-install
And search for it.
GNU ELPA provides the latest stable release. Those who prefer to follow the development process in order to report bugs or suggest changes, can use the version of the package from the GNU-devel ELPA archive. Read: https://protesilaos.com/codelog/2022-05-13-emacs-elpa-devel/.
Previous: GNU ELPA package, Up: Installation [Index]
Assuming your Emacs files are found in ‘~/.emacs.d/’, execute the following commands in a shell prompt:
cd ~/.emacs.d # Create a directory for manually-installed packages mkdir manual-packages # Go to the new directory cd manual-packages # Clone this repo, naming it "standard-themes" git clone https://github.com/protesilaos/standard-themes standard-themes
Finally, in your ‘init.el’ (or equivalent) evaluate this:
;; Make Elisp files in that directory available to the user. (add-to-list 'load-path "~/.emacs.d/manual-packages/standard-themes")
Everything is in place to set up the package.
Next: Customization options, Previous: Installation, Up: standard-themes: Like the default theme but more consistent [Index]
;; Make customisations that affect Emacs faces BEFORE loading a theme
;; (any change needs a theme re-load to take effect).
(require 'standard-themes)
;; Read the doc string of each of those user options. These are some
;; sample values.
(setq standard-themes-bold-constructs t
standard-themes-italic-constructs t
standard-themes-disable-other-themes t
standard-themes-mixed-fonts t
standard-themes-variable-pitch-ui t
standard-themes-prompts '(extrabold italic)
;; more complex alist to set weight, height, and optional
;; `variable-pitch' per heading level (t is for any level not
;; specified):
standard-themes-headings
'((0 . (variable-pitch light 1.9))
(1 . (variable-pitch light 1.8))
(2 . (variable-pitch light 1.7))
(3 . (variable-pitch semilight 1.6))
(4 . (variable-pitch semilight 1.5))
(5 . (variable-pitch 1.4))
(6 . (variable-pitch 1.3))
(7 . (variable-pitch 1.2))
(agenda-date . (1.3))
(agenda-structure . (variable-pitch light 1.8))
(t . (variable-pitch 1.1))))
(standard-themes-load-light) ; OR (standard-themes-load-dark)
(define-key global-map (kbd "<f5>") #'standard-themes-toggle)
Next: Loading a theme, Previous: Sample configuration, Up: standard-themes: Like the default theme but more consistent [Index]
The standard-themes provide user options which tweak secondary
aspects of the theme. All customizations need to be evaluated before
loading a theme. Any change after the theme has been loaded requires a
re-load (Loading a theme).
Next: Option to enable mixed fonts, Up: Customization options [Index]
The user option standard-themes-disable-other-themes controls
whether to disable other themes when loading a Standard theme (Loading a theme).
When the value is non-nil, the command standard-themes-toggle as
well as the functions standard-themes-load-dark and
standard-themes-load-light, will disable all other themes while
loading the given Standard theme. 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.
When the value is nil, the aforementioned command and functions will only disable the other Standard theme.
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.
Next: Option to control the UI typeface, Previous: Option to disable other themes, Up: Customization options [Index]
The user option standard-themes-mixed-fonts controls whether strictly
spacing-sensitive constructs inherit from fixed-pitch (a monospaced
font family) to ensure proper alignment at all times.
By default (a nil value for this user option) no face inherits from
fixed-pitch: they all use the default font family, regardless of
whether it is monospaced or not.
When standard-themes-mixed-fonts is set to a non-nil value, faces
such as for Org tables, inline code, code blocks, and the like, are
rendered in a monospaced font (the inherit the fixed-pitch face).
The user can thus set their default font family to a proportionately
spaced font without worrying about breaking the alignment of relevant
elements (or if they simply prefer the aesthetics of mixed mono and
proportionately spaced font families).
A temporary switch to a proportionately spaced font (known in Emacs as
variable-pitch) can be enabled in the current buffer with the
activation of the built-in variable-pitch-mode. Mixed fonts work
well in this case.
To get consistent typography, the user may need to edit the font
family of the fixed-pitch and variable-pitch faces. The
fontaine package on GNU ELPA (by Protesilaos) can be helpful in this
regard.
Next: Option to enable more bold constructs, Previous: Option to enable mixed fonts, Up: Customization options [Index]
The user option standard-themes-variable-pitch-ui controls whether
the elements of the User Interface (UI) use a proportionately spaced
font.
By default (a nil value), all UI elements use the default font
family. When this user option is set to a non-nil value, all UI
elements will inherit the face variable-pitch, thus rendering them
in a proportionately spaced font.
In this context, the UI elements are:
header-line
mode-line (active and inactive)
tab-bar-mode
tab-line-mode
To get consistent typography, the user may need to edit the font
family of the fixed-pitch and variable-pitch faces. The
fontaine package on GNU ELPA (by Protesilaos) can be helpful in this
regard.
Next: Option to enable more italic constructs, Previous: Option to control the UI typeface, Up: Customization options [Index]
The user option standard-themes-bold-constructs determines whether
select faces will inherit the bold face. When the value is
non-nil, a bold weight is applied to code constructs. This affects
keywords, builtins, and a few other elements.
Configure bold and italic faces.
Next: Option for command prompts, Previous: Option to enable more bold constructs, Up: Customization options [Index]
The user option standard-themes-italic-constructs determines whether
select faces will inherit the italic face. When the value is
non-nil, an italic style is applied to code constructs. This affects
comments, doc strings, and a few other minor elements.
Configure bold and italic faces.
Next: Option for headings, Previous: Option to enable more italic constructs, Up: Customization options [Index]
The user option standard-themes-prompts controls the style of all
prompts, such as those of the minibuffer and REPLs.
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:
italic
thin
ultralight
extralight
light
semilight
regular
medium
semibold
bold
heavy
extrabold
ultrabold
The default (a nil value or an empty list) means to only use a
foreground color without any typographic additions.
The italic property adds a slant to the font’s forms (italic or
oblique forms, depending on the typeface).
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 standard-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:
(bold italic) (italic semibold)
The order in which the properties are set is not significant.
In user configuration files the form may look like this:
(setq standard-themes-prompts '(extrabold italic))
The foreground and background colors of prompts can be modified by applying palette overrides (Palette overrides).
Next: Palette overrides, Previous: Option for command prompts, Up: Customization options [Index]
The user option standard-themes-headings provides support for individual
heading styles for regular heading levels 0 through 8, as well as the
Org agenda headings.
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.
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 ‘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:
(setq standard-themes-headings
'((1 . (variable-pitch 1.5))
(2 . (1.3))
(agenda-date . (1.3))
(agenda-structure . (variable-pitch light 1.8))
(t . (1.1))))
Properties:
thin
ultralight
extralight
light
semilight
regular
medium
semibold
bold (default)
heavy
extrabold
ultrabold
By default (a nil value for this variable), all headings have a bold
typographic weight and use a desaturated text color.
A variable-pitch property changes the font family of the heading to that
of the variable-pitch face (normally a proportionately spaced typeface).
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 standard-themes-weights. The absence of a weight
means that bold will be used by virtue of inheriting the bold face.
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:
(semibold) (variable-pitch semibold 1.3) (variable-pitch semibold (height 1.3)) ; same as above (variable-pitch semibold (height . 1.3)) ; same as above
The order in which the properties are set is not significant.
In user configuration files the form may look like this:
(setq standard-themes-headings
'((1 . (variable-pitch 1.5))
(2 . (1.3))
(agenda-date . (1.3))
(agenda-structure . (variable-pitch light 1.8))
(t . (1.1))))
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:
(setq standard-themes-headings
'((1 . t) ; keep the default style
(2 . (semibold 1.2))
(t . (rainbow)))) ; style for all other headings
(setq standard-themes-headings
'((1 . (variable-pitch 1.5))
(2 . (semibold))
(t . t))) ; default style for all other levels
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).
The foreground, background, and overline colors of headings can be modified by applying palette overrides (Palette overrides).
Previous: Option for headings, Up: Customization options [Index]
The Standard themes define their own color palette as well as semantic color mappings. The former is the set of color values such as what shade of blue to use. The latter refers to associations between a color value and a syntactic construct, such as a ‘variable’ for variables in programming modes or ‘heading-1’ for level 1 headings in Org and others.
The definition is stored in the variable ‘NAME-palette’, where ‘NAME’
is the symbol of the theme, such as standard-light. Overrides for
those associations are specified in the variable ‘NAME-palette-overrides’.
The variable standard-themes-common-palette-overrides is available
for shared values. It is advised to only use this for mappings that
do not specify a color value directly. This way, the text remains
legible by getting the theme-specific color value it needs.
All associations take the form of ‘(KEY VALUE)’ pairs. For example,
the standard-light-palette contains ‘(blue-warmer "#3a5fcd")’.
Semantic color mappings are the same, though the ‘VALUE’ is one of the
named colors of the theme. For instance, standard-light-palette
maps the aforementioned like ‘(link blue-warmer)’.
The easiest way to learn about a theme’s definition is to use the
command describe-variable (bound to ‘C-h v’ by default) and then
search for the ‘NAME-palette’. The resulting Help buffer will look
like this:
standard-light-palette is a variable defined in ‘standard-light-theme.el’. Its value is shown below. The ‘standard-light’ palette. This variable may be risky if used as a file-local variable. Value: ((bg-main "#ffffff") (fg-main "#000000") (bg-dim "#ededed") [... Shortened for the purposes of this manual.]
The user can study this information to identify the overrides they wish to make. Then they can specify them and re-load the theme for changes to take effect. Sample of how to override a color value and a semantic mapping:
(setq standard-light-palette-overrides
'((blue-warmer "#5230ff") ; original value is #3a5fcd
(variable blue-warmer))) ; original value is yellow-cooler
The overrides can contain as many associations as the user needs.
Changes to color values are reflected in the preview of the theme’s palette (Preview theme colors). They are shown at the top of the buffer. In the above example, the first instance of ‘blue-warmer’ is the override and the second is the original one.
Contact me if you need further help with this.
Next: Preview theme colors, Previous: Customization options, Up: standard-themes: Like the default theme but more consistent [Index]
Emacs can load and maintain enabled multiple themes at once. This
typically leads to awkward styling and weird combinations. The theme
looks broken and the designer’s intent is misunderstood. Before
loading either of the standard-themes, the user is encouraged to
disable all others (Disable other themes):
(mapc #'disable-theme custom-enabled-themes)
Then load the theme of choice. For example:
(load-theme 'standard-light :no-confirm)
The ‘:no-confirm’ is optional. It simply skips the step where Emacs asks the user whether they are sure about loading the theme.
Consider adding code like the above to the user configuration file, such as ‘init.el’.
As the Standard themes are extensible, another way to load the theme
of choice is to use either standard-themes-load-dark or
standard-themes-load-light. These functions take care to (i) disable
other themes, (ii) load the specified Standard theme, and (iii) run
the standard-themes-post-load-hook which is useful for
do-it-yourself customizations (The general approach to DIY changes).
These two functions are also called by the command
standard-themes-toggle.
Next: Use colors from the active Standard theme, Previous: Loading a theme, Up: standard-themes: Like the default theme but more consistent [Index]
The command standard-themes-preview-colors uses minibuffer
completion to select an item from the Standard themes and then
produces a buffer with previews of its color palette entries. The
buffer has a naming scheme which reflects the given choice, like
‘standard-light-preview-colors’ for the standard-light theme.
The command standard-themes-preview-colors-current skips the
minibuffer selection process and just produces a preview for the
current Standard theme.
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.
Aliases for those commands are standard-themes-list-colors and
standard-themes-list-colors-current.
Overrides to color values are reflected in the buffers produced by the aforementioned commands (Palette overrides).
Each row shows a foreground and background coloration using the underlying value it references. For example a line with ‘#b3303a’ (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 Standard theme and what the contents are, such as ‘*standard-light-list-colors*’ for named colors and ‘=*standard-light-list-mappings*’ for the semantic color mappings.
Next: Do-It-Yourself customizations, Previous: Preview theme colors, Up: standard-themes: Like the default theme but more consistent [Index]
Advanced users may want to call color variables from the palette of
the active Standard theme. The macro standard-themes-with-colors
supplies those to any form called inside of it. For example:
(standard-themes-with-colors
(list bg-main fg-main bg-mode-line))
;; => ("#ffffff" "#000000" "#b3b3b3")
The above return value is for ‘standard-light’ when that is the active Standard theme. Switching to ‘standard-dark’ and evaluating this code anew will give us the relevant results for that theme:
(standard-themes-with-colors
(list bg-main fg-main bg-mode-line cursor))
;; => ("#000000" "#ffffff" "#505050")
Do-It-Yourself customizations.
The palette of each Standard theme is considered stable. No removals
shall be made. Though please note that some tweaks to individual hues
or color mapping are still possible. At any rate, we will not
outright break any code that uses standard-themes-with-colors.
Next: Faces defined by the Standard themes, Previous: Use colors from the active Standard theme, Up: standard-themes: Like the default theme but more consistent [Index]
This section shows how the user can tweak the Standard themes to their
liking, often by employing the standard-themes-with-colors macro
(Use colors from the active Standard theme).
org-modern timestampsThe general approach to advanced DIY changes.
The fuction standard-themes-get-color-value can be called from Lisp
to return the value of a color from the active Standard theme palette.
It takea a ‘COLOR’ argument and an optional ‘OVERRIDES’.
‘COLOR’ is a symbol that represents a named color entry in the palette.
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.
With an optional ‘OVERRIDES’ argument as a non-nil value, it accounts for palette overrides. Else it reads only the default palette.
With optional ‘THEME’ as a symbol among standard-themes-collection,
use the palette of that item. Else use the current Standard theme.
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.
An example with standard-light to show how this function behaves
with/without overrides and when recursive mappings are introduced.
;; 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 standard-themes-common-palette-overrides
'((cursor red)
(prompt cursor)
(variable prompt)))
;; Ignore the overrides and get the original value.
(standard-themes-get-color-value 'variable)
;; => "#a0522d"
;; Read from the overrides and deal with any recursion to find the
;; underlying value.
(standard-themes-get-color-value 'variable :overrides)
;; => "#b3303a"
Next: A theme-agnostic hook for theme loading, Previous: Get a single color from the palette, Up: Do-It-Yourself customizations [Index]
When the user wants to customize Emacs faces there are two considerations they need to make if they care about robustness:
For point 1 we provide the standard-themes-with-colors macro, while for
point 2 we have the standard-themes-post-load-hook. The hook runs
at the end of the command standard-themes-toggle.
Use colors from the active Standard theme.
A theme-agnostic hook for theme loading.
We need to wrap our code in the standard-themes-with-colors and
declare it as a function which we then add to the hook. Here we show
the general approach of putting those pieces together.
To customize faces in a way that mirrors the Standard themes’ source
code, we use the built-in custom-set-faces. The value it accepts
has the same syntax as that found in ‘standard-themes.el’,
specifically the standard-themes-faces constant. It thus is easy to
copy lines from there and tweak them. Let’s pick a couple of
font-lock faces (used in all programming modes, among others):
(defun my-standard-themes-custom-faces ()
"My customizations on top of the Standard themes.
This function is added to the `standard-themes-post-load-hook'."
(standard-themes-with-colors
(custom-set-faces
;; These are the default specifications
`(font-lock-comment-face ((,c :inherit standard-themes-italic :foreground ,comment)))
`(font-lock-variable-name-face ((,c :foreground ,variable))))))
;; Using the hook lets our changes persist when we use the commands
;; `standard-themes-toggle', `standard-themes-load-dark',
;; `standard-themes-load-light'.
(add-hook 'standard-themes-post-load-hook #'my-standard-themes-custom-faces)
Each of the Standard themes has its own color palette and corresponding mapping of values to constructs. So the color of the ‘comment’ variable will differ between the themes. For the purpose of our demonstration, we make variables look like comments and comments like variables:
(defun my-standard-themes-custom-faces ()
"My customizations on top of the Standard themes.
This function is added to the `standard-themes-post-load-hook'."
(standard-themes-with-colors
(custom-set-faces
`(font-lock-comment-face ((,c :foreground ,variable)))
`(font-lock-variable-name-face ((,c :inherit standard-themes-italic :foreground ,comment))))))
;; Using the hook lets our changes persist when we use the commands
;; `standard-themes-toggle', `standard-themes-load-dark',
;; `standard-themes-load-light'.
(add-hook 'standard-themes-post-load-hook #'my-standard-themes-custom-faces)
All changes take effect when a theme is loaded again. As such, it is
better to use either standard-themes-load-dark or
standard-themes-load-light at startup so that the function added to
the hook gets applied properly upon first load. Like this:
(defun my-standard-themes-custom-faces ()
"My customizations on top of the Standard themes.
This function is added to the `standard-themes-post-load-hook'."
(standard-themes-with-colors
(custom-set-faces
`(font-lock-comment-face ((,c :foreground ,variable)))
`(font-lock-variable-name-face ((,c :inherit standard-themes-italic :foreground ,comment))))))
;; Using the hook lets our changes persist when we use the commands
;; `standard-themes-toggle', `standard-themes-load-dark',
;; `standard-themes-load-light'.
(add-hook 'standard-themes-post-load-hook #'my-standard-themes-custom-faces)
;; Load the theme and run `standard-themes-post-load-hook'
(standard-themes-load-light) ; OR (standard-themes-load-dark)
Please contact us if you have specific questions about this mechanism. We are willing to help and shall provide comprehensive documentation where necessary.
Next: Add support for hl-todo, Previous: The general approach to advanced DIY changes, Up: Do-It-Yourself customizations [Index]
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 standard-themes-post-load-hook,
which is called after the evaluation of any of the commands we provide
for loading a theme (Loading a theme). 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 Standard themes
and other items (e.g. the modus-themes and ef-themes) will find
that such a hook does not meet their requirements: it only works with
the Standard themes and only with the functions they provide.
A theme-agnostic setup can be configured thus:
(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)
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
standard-themes-select and the others mentioned in this manual. The
function 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 standard-themes-with-colors (the Modus and Ef
themes have an equivalent macro). Not all Emacs themes have the same
capabilities.
In this document, we always mention standard-themes-post-load-hook
though the user can replace it with after-enable-theme-hook should
they need to (provided they understand the implications).
Next: Configure bold and italic faces, Previous: A theme-agnostic hook for theme loading, Up: Do-It-Yourself customizations [Index]
The ‘hl-todo’ package provides the user option hl-todo-keyword-faces:
it specifies an association list of ‘(KEYWORD . COLOR-VALUE)’ pairs.
There are no faces, which the theme could style seamlessly. As such, it
rests on the user to specify appropriate color values. This can be done
either by hardcoding colors, which is inefficient, or by using the macro
standard-themes-with-colors (The general approach to DIY changes).
Here we show the latter method.
(defun my-standard-themes-hl-todo-faces ()
"Configure `hl-todo-keyword-faces' with Standard themes colors.
The exact color values are taken from the active Standard theme."
(standard-themes-with-colors
(setq hl-todo-keyword-faces
`(("HOLD" . ,yellow)
("TODO" . ,red)
("NEXT" . ,blue)
("THEM" . ,magenta)
("PROG" . ,cyan-warmer)
("OKAY" . ,green-warmer)
("DONT" . ,yellow-warmer)
("FAIL" . ,red-warmer)
("BUG" . ,red-warmer)
("DONE" . ,green)
("NOTE" . ,blue-warmer)
("KLUDGE" . ,cyan)
("HACK" . ,cyan)
("TEMP" . ,red)
("FIXME" . ,red-warmer)
("XXX+" . ,red-warmer)
("REVIEW" . ,red)
("DEPRECATED" . ,yellow)))))
(add-hook 'standard-themes-post-load-hook #'my-standard-themes-hl-todo-faces)
To find the names of the color variables, the user can rely on the commands for previewing the palette (Preview theme colors).
Next: Tweak org-modern timestamps, Previous: Add support for hl-todo, Up: Do-It-Yourself customizations [Index]
The Standard themes do not hardcode a :weight or :slant attribute in the
faces they cover. Instead, they configure the generic faces called
bold and italic to use the appropriate styles and then instruct all
relevant faces that require emphasis to inherit from them.
This practically means that users can change the particularities of what
it means for a construct to be bold/italic, by tweaking the bold and
italic faces. Cases where that can be useful include:
bold use a
semibold weight.
italic face.
To achieve those effects, one must first be sure that the fonts they use have support for those features.
In this example, we set the default font family to Fira Code, while we choose to render italics in the Hack typeface (obviously one needs to pick fonts that work in tandem):
(set-face-attribute 'default nil :family "Fira Code" :height 110) (set-face-attribute 'italic nil :family "Hack")
And here we play with different weights, using Source Code Pro:
(set-face-attribute 'default nil :family "Source Code Pro" :height 110 :weight 'light) (set-face-attribute 'bold nil :weight 'semibold)
To reset the font family, one can use this:
(set-face-attribute 'italic nil :family 'unspecified)
Consider the fontaine package on GNU ELPA (by Protesilaos) which
provides the means to configure font families via faces.
Next: Tweak goto-address-mode faces, Previous: Configure bold and italic faces, Up: Do-It-Yourself customizations [Index]
org-modern timestampsThe org-modern package uses faces and text properties to make Org
buffers more aesthetically pleasing. It affects tables, timestamps,
lists, headings, and more.
In previous versions of the Standard themes, we mistakenly affected one of its
faces: the org-modern-label. It changed the intended looks and
prevented the user option org-modern-label-border from having its
desired effect. As such, we no longer override that face.
Users who were used to the previous design and who generally do not
configure the user options of org-modern may thus notice a change in
how clocktables (or generally tables with timestamps) are aligned. The
simplest solution is to instruct the mode to not prettify timestamps, by
setting the user option org-modern-timestamp to nil. For example, by
adding this to the init file:
(setq org-modern-timestamp nil)
Alignment in tables will also depend on the use of proportionately spaced fonts. Enable the relevant option to work with those without any further trouble (Enable mixed fonts).
For any further issues, you are welcome to ask for help.
Previous: Tweak org-modern timestamps, Up: Do-It-Yourself customizations [Index]
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
minor-mode automatically.
The faces are not declared with defface, meaning that it is better
that the theme does not modify them. The user is thus encouraged to
consider including this in their setup:
(setq goto-address-url-face 'link
goto-address-url-mouse-face 'highlight
goto-address-mail-face 'link
goto-address-mail-mouse-face 'highlight)
My personal preference is to set goto-address-mail-face to nil,
because it otherwise adds too much visual noise to the buffer (email
addresses stand out more, due to the use of the uncommon ‘@’ caharacter
but also because they are often enclosed in angled brackets).
Next: Supported packages or face groups, Previous: Do-It-Yourself customizations, Up: standard-themes: Like the default theme but more consistent [Index]
The themes define some faces to make it possible to achieve
consistency between various groups of faces. For example, all “marks
for selection” use the standard-themes-mark-select face. If, say, the
user wants to edit this face to include an underline, the change will
apply to lots of packages, like Dired, Trashed, Ibuffer.
Do-It-Yourself customizations.
All the faces defined by the themes:
standard-themes-bold
standard-themes-fixed-pitch
standard-themes-fringe-error
standard-themes-fringe-info
standard-themes-fringe-warning
standard-themes-heading-0
standard-themes-heading-1
standard-themes-heading-2
standard-themes-heading-3
standard-themes-heading-4
standard-themes-heading-5
standard-themes-heading-6
standard-themes-heading-7
standard-themes-heading-8
standard-themes-intense-blue
standard-themes-intense-cyan
standard-themes-intense-green
standard-themes-intense-magenta
standard-themes-intense-red
standard-themes-intense-yellow
standard-themes-italic
standard-themes-key-binding
standard-themes-mark-delete
standard-themes-mark-other
standard-themes-mark-select
standard-themes-nuanced-blue
standard-themes-nuanced-cyan
standard-themes-nuanced-green
standard-themes-nuanced-magenta
standard-themes-nuanced-red
standard-themes-nuanced-yellow
standard-themes-prompt
standard-themes-subtle-blue
standard-themes-subtle-cyan
standard-themes-subtle-green
standard-themes-subtle-magenta
standard-themes-subtle-red
standard-themes-subtle-yellow
standard-themes-ui-variable-pitch
standard-themes-underline-error
standard-themes-underline-info
standard-themes-underline-warning
Next: Acknowledgements, Previous: Faces defined by the Standard themes, Up: standard-themes: Like the default theme but more consistent [Index]
The standard-themes will only ever support a curated list of packages based
on my judgement (Packages that are hard to support). Nevertheless, the
list of explicitly or implicitly supported packages already covers
everything most users need.
display-line-numbers-mode and global variant)
Next: Packages that are hard to support, Previous: Explicitly supported packages or face groups, Up: Supported packages or face groups [Index]
Those are known to work with the Standard themes either because their colors are appropriate or because they inherit from basic faces which the themes already cover:
Note that “implicitly supported” does not mean that they always fit in perfectly. If there are refinements we need to made, then we need to intervene (Explicitly supported packages or face groups).
Previous: Implicitly supported packages or face groups, Up: Supported packages or face groups [Index]
These are difficult to support due to their (i) incompatibility with the
design of the standard-themes, (ii) complexity or multiple points of entry,
(iii) external dependencies, (iv) existence of better alternatives in my
opinion, or (v) inconsiderate use of color out-of-the-box and implicit
unwillingness to be good Emacs citizens:
its UI is prone to visual breakage and is hard to style correctly.
has an external dependency that I don’t use.
use the built-in isearch or the consult-line command of
consult.
it is complex and makes inconsiderate use of color.
external dependency that I don’t use.
has an external dependency that I don’t use.
it is complex and makes inconsiderate use of color. Prefer
the vertico, consult, and embark packages.
it is complex and makes inconsiderate use of color.
use the vertico, consult, and embark
packages which are designed to be compatible with standard Emacs
mechanisms and are modular.
has external dependencies that I don’t use.
in principle, it is incompatible with practically every theme that is not designed around it. Emacs does not distinguish between “UI” and “syntax” buffers.
has an external dependency that I don’t use.
has an external dependency that I don’t use (I don’t even have a smartphone).
it has too many dependencies and does too many things.
I don’t use all those Web technologies and cannot test this properly without support from an expert. It also defines lots of faces that hardcode color values for no good reason.
The above list is non-exhaustive though you get the idea.
Next: GNU Free Documentation License, Previous: Supported packages or face groups, Up: standard-themes: Like the default theme but more consistent [Index]
This project is meant to be a collective effort. Every bit of help matters.
Protesilaos Stavrou.
Clemens Radermacher.
Filippo Argiolas, Fritz Grabo, Manuel Uberti, Tassilo Horn, Zack Weinberg.
Next: Indices, Previous: Acknowledgements, Up: standard-themes: Like the default theme but more consistent [Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. https://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
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.
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.
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.
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.
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:
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.
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.”
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.
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.
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.
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.
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.
“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.
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.
Previous: GNU Free Documentation License, Up: standard-themes: Like the default theme but more consistent [Index]
Next: Variable index, Up: Indices [Index]
| Jump to: | S |
|---|
| Jump to: | S |
|---|
Next: Concept index, Previous: Function index, Up: Indices [Index]
| Jump to: | S |
|---|
| Jump to: | S |
|---|
Previous: Variable index, Up: Indices [Index]
| Jump to: | B C I O |
|---|
| Jump to: | B C I O |
|---|