branch: externals/standard-themes
commit c7ec2c1dd4eb0ba804dbe1aac53e19eaa0c88a5d
Author: Protesilaos Stavrou <[email protected]>
Commit: Protesilaos Stavrou <[email protected]>
Update the manual about standard-themes-prompts
---
README.org | 39 +++++++++++++++++++++++++++++----------
1 file changed, 29 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index d7cd9431cd..4856e5f628 100644
--- a/README.org
+++ b/README.org
@@ -370,24 +370,43 @@ Please refer to their documentation strings.
The user option ~standard-themes-prompts~ controls the style of all
prompts, such as those of the minibuffer and REPLs.
-The value is a list of properties, each designated by a symbol. The
-default (a ~nil~ value or an empty list) means to only use an accented
-foreground color.
+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:
-The property ~background~ applies a background color to the prompt's
-text and adjusts the foreground accordingly.
++ ~italic~
++ ~italic~
++ A font weight, which must be supported by the underlying typeface:
+ - ~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
+subtle colored foreground color.
-The property ~bold~ makes the text use a bold typographic weight.
-Similarly, ~italic~ adds a slant to the font's forms (italic or
+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:
#+begin_src emacs-lisp
-(background)
(bold italic)
-(background bold italic)
+(italic semibold)
#+end_src
The order in which the properties are set is not significant.
@@ -395,7 +414,7 @@ The order in which the properties are set is not
significant.
In user configuration files the form may look like this:
#+begin_src emacs-lisp
-(setq standard-themes-prompts '(background bold))
+(setq standard-themes-prompts '(extrabold italic))
#+end_src
** Option for headings
