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

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

[elpa] externals/auctex 728db25bf7 69/77: Update documentation


From: Tassilo Horn
Subject: [elpa] externals/auctex 728db25bf7 69/77: Update documentation
Date: Fri, 26 Aug 2022 16:06:38 -0400 (EDT)

branch: externals/auctex
commit 728db25bf736f382a25da74fcd653ce81589c720
Author: Ikumi Keita <ikumi@ikumi.que.jp>
Commit: Ikumi Keita <ikumi@ikumi.que.jp>

    Update documentation
    
    * doc/changes.texi: Announce that `master-buffer' and `orig-buffer'
    aren't accessible in `TeX-region-hook'.
    * doc/auctex.texi (Adding Environments): Update example to the current
    usage.
    (Hacking the Parser): Add @findex for `TeX-auto-add-regexp' and FIXME
    comment.
    * doc/todo.texi (Mid-term Goals): Add todo and rearrange the item to
    look better.
---
 doc/auctex.texi  |  6 +++++-
 doc/changes.texi | 10 ++++++++++
 doc/todo.texi    | 19 +++++++++++++++++--
 3 files changed, 32 insertions(+), 3 deletions(-)

diff --git a/doc/auctex.texi b/doc/auctex.texi
index 2ca3dfc766..fb34568b44 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -5670,7 +5670,7 @@ an optional argument of the @samp{lstlisting} environment:
 @lisp
 (LaTeX-add-environments
  '("lstlisting" LaTeX-env-args
-   [TeX-arg-key-val LaTeX-listings-key-val-options]))
+   [TeX-arg-key-val (LaTeX-listings-key-val-options)]))
 @end lisp
 @end ftable
 
@@ -5830,6 +5830,7 @@ Which see.
 @cindex @file{macro.tex}
 @cindex @file{macro.el}
 @cindex Changing the parser
+@findex TeX-auto-add-regexp
 
 The automatic @TeX{} information extractor works by searching for
 regular expressions in the @TeX{} files, and storing the matched
@@ -5934,6 +5935,9 @@ List of functions to be called before parsing a @TeX{} 
file.
 List of functions to be called after parsing a @TeX{} file.
 @end defvar
 
+@c FIXME: Write a @defun for `TeX-auto-add-regexp' here.  Then we can omit
+@c its @findex below the subsection heading.
+
 @node Appendices
 @appendix Copying, Changes, Development, FAQ, Texinfo Mode
 
diff --git a/doc/changes.texi b/doc/changes.texi
index 5994900264..debfec688b 100644
--- a/doc/changes.texi
+++ b/doc/changes.texi
@@ -87,6 +87,16 @@ files aren't located at the master directory.
 
 To achieve that, set new user option @code{TeX-auto-save-aggregate} to
 @code{nil}.
+
+@item
+There was another hook where former dynamic free variables could be used.
+The usage was invalidated at version 13.1, by introduction of lexical
+binding over @AUCTeX{}.
+
+The functions in @code{TeX-region-hook} could access the free variables
+@code{master-buffer} and @code{orig-buffer}.  Those are now named
+@code{TeX-region-master-buffer} and @code{TeX-region-orig-buffer},
+respectively.
 @end itemize
 
 @heading News in 13.1
diff --git a/doc/todo.texi b/doc/todo.texi
index 87fb3b8ea2..2fbf975b42 100644
--- a/doc/todo.texi
+++ b/doc/todo.texi
@@ -86,9 +86,24 @@ Hence syntax propertization should be factored out from
 propertize function, which just copies the one available in Emacs built-in
 texinfo mode.)
 
+@item Add documentation
+
+Following entries should be included in the document:
+@itemize @minus
+@item
+Variables @code{LaTeX-insert-into-commments}, 
@code{TeX-translate-location-hook}
+
 @item
-Document @code{LaTeX-insert-into-commments},
-@code{TeX-translate-location-hook}, and usage of @ConTeXt{} mode.
+How to use @code{TeX-auto-add-type}, as well as functions and variables
+generated by that macro.
+@ifclear rawfile
+They should be covered in the node @ref{Hacking the Parser}.
+@end ifclear
+
+@item
+Usage of @ConTeXt{} mode
+@end itemize
+
 @end itemize
 
 @node Wishlist



reply via email to

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