[AUCTeX-diffs] Changes to auctex/font-latex.el,v

[Ralf Angeli]

CVSROOT:        /cvsroot/auctex
Module name:    auctex
Changes by:     Ralf Angeli <angeli>    07/10/03 12:20:52

Index: font-latex.el
===================================================================
RCS file: /cvsroot/auctex/auctex/font-latex.el,v
retrieving revision 5.177
retrieving revision 5.178
diff -u -b -r5.177 -r5.178
--- font-latex.el       26 Aug 2007 08:19:23 -0000      5.177
+++ font-latex.el       3 Oct 2007 12:20:51 -0000       5.178
@@ -611,42 +611,52 @@
 (font-latex-make-built-in-keywords)
 
 (defcustom font-latex-user-keyword-classes nil
-  "User-defined keyword classes and specifications for font locking.
+  "List of user-defined keyword classes for font locking.
+
+Every keyword class consists of four parts, a name, a list of
+keywords, a face and a specifier for the type of macros to be
+highlighted.
 
 When adding new entries, you have to use unique values for the
 class names, i.e. they must not clash with names of the built-in
 keyword classes or other names given by you.  Additionally the
 names must not contain spaces.
 
-The keywords are names of commands you want to match omitting the
-leading backslash.  In case you want to match LaTeX macros with
-arguments (see below), you should choose the option \"Keywords
-with specs\" which lets you specify the occurence and order of
-optional (\"[\") and mandatory (\"{\") arguments for each
-keyword.  For example for \"documentclass\" you'd use \"[{\"
-because the macro has one optional followed by one mandatory
-argument.  Optionally starred macros can be indicated with \"*\".
-In case an argument is an unbraced macro, use \"\\\".  You can
-also specify two alternatives by prefixing them with \"|\".  As
-an example, the specifier for \\newcommand is \"*|{\\[[{\".
-
-The face argument can either be an existing face or font
-specifications made by you.  (The latter option is not available
-on XEmacs.)
-
-There are three alternatives for the type of keywords:
-
-\"Command with arguments\" comprises commands with the syntax
-\"\\foo[bar]{baz}\".  The mandatory arguments in curly braces
-will get the face you specified.
-
-\"Declaration inside TeX group\" comprises commands with the
-syntax \"{\\foo bar}\".  The content inside the braces, excluding
-the command will get the face you specified.  In case the braces
-are missing, the face will be applied to the command itself.
-
-\"Command without arguments\" comprises commands with the syntax
-\"\\foo\".  The command itself will get the face you specified.
+The list of keywords defines which commands and declarations
+should be covered by the keyword class.  A keyword can either be
+a simple command name omitting the leading backslash or a list
+consisting of the command name and a string specifying the syntax
+of the command.  This is useful if you want to match LaTeX macros
+with arguments (see below).  In that case you should choose the
+option \"Keywords with specs\" which lets you specify the
+occurence and order of optional (\"[\") and mandatory (\"{\")
+arguments for each keyword.  For example for \"documentclass\"
+you'd use \"[{\" because the macro has one optional followed by
+one mandatory argument.  Optionally starred macros can be
+indicated with \"*\".  In case an argument is an unbraced macro,
+use \"\\\".  You can also specify two alternatives by prefixing
+them with \"|\".  As an example, the specifier for \\newcommand
+is \"*|{\\[[{\".
+
+The face argument can either be an existing face or a font
+specification made by you.  (The latter option is not available
+in XEmacs.)
+
+There are three alternatives for the class type:
+
+\"Command with arguments\" (symbol: 'command) comprises commands
+with the syntax \"\\foo[bar]{baz}\".  The mandatory arguments in
+curly braces will get the face you specified.
+
+\"Declaration inside TeX group\" (symbol: 'declaration) comprises
+commands with the syntax \"{\\foo bar}\".  The content inside the
+braces, excluding the command will get the face you specified.
+In case the braces are missing, the face will be applied to the
+command itself.
+
+\"Command without arguments\" (symbol: 'noarg) comprises commands
+with the syntax \"\\foo\".  The command itself will get the face
+you specified.
 
 Setting this variable directly does not take effect;
 use \\[customize] or restart Emacs."