From: Eshel Yaron <me@eshelyaron.com>
Date: Sat, 24 Sep 2022 14:33:23 +0000 (+0300)
Subject: DOC: document new user option sweep-faces-style
X-Git-Tag: v0.3.3~2
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=07fc84b716ba243504400ba2134e9d72548ae8f0;p=sweep.git

DOC: document new user option sweep-faces-style
---

diff --git a/NEWS.org b/NEWS.org
index cfc5222..8466c49 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -30,6 +30,12 @@ Follows file specifications in =sweep-mode= buffers.
 
 * New user options available in =sweep= {{{version({{{input-file}}})}}}
 
+** New user option =sweep-faces-style=
+
+This option controls the which style of faces will be used for
+highlighting in =sweep-mode= buffers.  Possible options are =light=, =dark=
+and =default=.
+
 ** New user option =sweep-indent-offset=
 
 This option, set by default to 4, is an integer denoting the number of
diff --git a/README.org b/README.org
index 84809c8..ac65510 100644
--- a/README.org
+++ b/README.org
@@ -422,17 +422,23 @@ highlighting can be set via the user option
 =sweep= defines more than 60 different faces (named sets of properties
 that determine the appearance of a specific text in Emacs buffers, see
 also [[info:emacs#Faces][Faces in the Emacs manual]]) to signify the specific semantics of
-each token in a Prolog code buffer.  For example, calls to built in
-Prolog predicates are highlighted with the =sweep-built-in-face=, while
-recursive calls to predicates in their own definitions are assigned
-the =sweep-recursion-face=.  The different appearance properties
-associated which each face, like color, font, etc., can be customized
-according to best suite the user's preferences.  By default, =sweep=
-defines its faces to inherit from standard Emacs faces such as
-=font-lock-variable-face= commonly used for variables in different
-programming languages, which =sweep= uses a basis for
-=sweep-variable-face=.  To view and customize all of the faces defined
-and used in =sweep=, type =M-x customize-group RET sweep-faces RET=.
+each token in a Prolog code buffer.  =sweep= comes with three /styles/:
+
+- The =default= style includes faces that mostly inherit from
+standard Emacs faces commonly used in programming modes.
+- The =light= style mimics the colors used in the SWI-Prolog built-in
+  editor.
+- The =light= style mimics the colors used in the SWI-Prolog built-in
+  editor in dark mode.
+
+#+VINDEX: sweep-faces-style
+To choose a style, customize the user option =sweep-faces-style= with
+=M-x customize-option RET sweep-faces-style RET=.  The new style will
+apply to all new =sweep-mode= buffers.  To apply the new style to an
+existing buffer, use =C-x x f= (=font-lock-update=) in that buffer.
+
+To view and customize all of the faces defined and used in =sweep=, type
+=M-x customize-group RET sweep-faces RET=.
 
 ** Definitions and references
 :PROPERTIES: