emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/auctex 15d930194d: Add convention for package/class key


From: ELPA Syncer
Subject: [elpa] externals/auctex 15d930194d: Add convention for package/class key=val options
Date: Wed, 20 Nov 2024 18:57:22 -0500 (EST)

branch: externals/auctex
commit 15d930194d56cf635ba90d1adb6c39e30b38aaa9
Author: Arash Esbati <arash@gnu.org>
Commit: Arash Esbati <arash@gnu.org>

    Add convention for package/class key=val options
    
    * doc/auctex.texi (Adding Other): Mention the convention for the
    name of the variable containing package/class key=val options.
---
 doc/auctex.texi | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/auctex.texi b/doc/auctex.texi
index 114b9e8ddb..72430e807d 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -6114,7 +6114,6 @@ Here is an excerpt from @samp{acro.el}:
 
 As you can see in the above example, a utility function
 @code{TeX-read-key-val} is available to read key-value pair(s) from users.
-
 Note that @code{defvar} or @code{defun} of
 @code{LaTeX-@var{packagename}-package-options} should be at the top level
 of the style file and not inside the style hook, because the style hook is
@@ -6133,6 +6132,11 @@ List of optional arguments available for the class.
 Which see.
 @end defun
 
+In case the utility function @code{TeX-read-key-val} is used, the variable
+containing the key-value pair(s) should be called
+@code{LaTeX-@var{packagename}-package-options-list} or
+@code{LaTeX-@var{classname}-class-options-list} accordingly.
+
 @node Hacking the Parser
 @subsection Automatic Extraction of New Things
 @cindex Parsing new macros
@@ -6150,8 +6154,8 @@ For example, in the file @file{macro.tex} I define the 
following macro.
 
 @example
 \newcommand@{\newmacro@}[5]@{%
-\def#1@{#3\index@{#4@@#5~cite@{#4@}@}\nocite@{#4@}@}%
-\def#2@{#5\index@{#4@@#5~cite@{#4@}@}\nocite@{#4@}@}%
+  \def#1@{#3\index@{#4@@#5~cite@{#4@}@}\nocite@{#4@}@}%
+  \def#2@{#5\index@{#4@@#5~cite@{#4@}@}\nocite@{#4@}@}%
 @}
 @end example
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]