]> git.eshelyaron.com Git - sweep.git/commitdiff
DOC: document quasi-quotation highlighting in the manual v0.4.3
authorEshel Yaron <me@eshelyaron.com>
Fri, 30 Sep 2022 06:54:01 +0000 (09:54 +0300)
committerEshel Yaron <me@eshelyaron.com>
Fri, 30 Sep 2022 06:54:01 +0000 (09:54 +0300)
README.org
sweeprolog.el

index 7d6944744e6c043d158aa3f11c0ff9239ea24834..0d8fbc53af0c33f0391282674332b852c10fc835 100644 (file)
@@ -459,9 +459,9 @@ To choose a style, customize the user option =sweeprolog-faces-style= with
 apply to all new =sweeprolog-mode= buffers.  To apply the new style to an
 existing buffer, use =C-x x f= (=font-lock-update=) in that buffer.
 
-*** Extra highlighting features
+*** Highlighting occurrences of a variable
 :PROPERTIES:
-:CUSTOM_ID: highlighting-extras
+:CUSTOM_ID: variable-highlighting
 :END:
 
 #+CINDEX: variable highlighting
@@ -485,6 +485,26 @@ highlight, defaulting to the variable at point, if any.  If called
 with a prefix argument (=C-u M-x sweeprolog-highlight-variable=), it
 clears all variable highlighting in the current clause instead.
 
+*** Quasi-quotation highlighting
+:PROPERTIES:
+:CUSTOM_ID: qq-highlighting
+:END:
+
+Quasi-quotations in =sweeprolog-mode= buffer are highlighted according
+to the Emacs mode corresponding to the quoted language by default.
+
+#+VINDEX: sweeprolog-qq-mode-alist
+The association between SWI-Prolog quasi-quotation types and Emacs
+major modes is determined by the user option =sweeprolog-qq-mode-alist=.
+To modify the default associations provided by =sweeprolog-mode=, type
+=M-x customize-option RET sweeprolog-qq-mode-alist RET=.
+
+If a quasi-quotation type does not have a matching mode in
+=sweeprolog-qq-mode-alist=, the function =sweeprolog-qq-content-face= is
+used to determine a default face for quoted content.
+
+
+
 ** Term-based editing and motion commands
 :PROPERTIES:
 :CUSTOM_ID: term-based-commands
index 3846c2cee04e6161c1812f079c59d50a688bcc67..6a14623e8998368bdaa16bb6b271b33dcfcf6213 100644 (file)
@@ -6,7 +6,7 @@
 ;; Maintainer: Eshel Yaron <~eshel/dev@lists.sr.ht>
 ;; Keywords: prolog languages extensions
 ;; URL: https://git.sr.ht/~eshel/sweep
-;; Package-Version: 0.4.2
+;; Package-Version: 0.4.3
 ;; Package-Requires: ((emacs "28"))
 
 ;; This file is NOT part of GNU Emacs.
 (defcustom sweeprolog-qq-mode-alist '(("graphql"    . graphql-mode)
                                       ("javascript" . js-mode)
                                       ("html"       . html-mode))
-  "Association between Prolog quasi-quotation types and Emacs modes."
+  "Association between Prolog quasi-quotation types and Emacs modes.
+
+This is a list of pairs of the form (TYPE . MODE), where TYPE is
+a Prolog quasi-quotation type given as a string, and MODE is a
+symbol specifing a major mode."
   :package-version '((sweeprolog . "0.4.3"))
   :type '(alist :key-type string :value-type symbol)
   :group 'sweeprolog)