branch: feature/fix-mode-names-overlap
commit 142f28b5394b19b2e661a26cd1b3baae836a523a
Author: Ikumi Keita <[email protected]>
Commit: Ikumi Keita <[email protected]>
Update documents
* doc/auctex.texi (Modes and Hooks): Update mode names in the table.
Add an explanation about additional hooks.
Update mode names.
* doc/changes.texi:
* doc/install.texi:
* doc/quickstart.texi:
* doc/todo.texi:
* latex/preview.dtx:
Update mode names in Local Variables section.
* doc/preview-faq.texi:
* doc/preview-problems.texi:
* doc/preview-readme.texi:
* doc/preview-todo.texi:
Add Local Variables section.
---
doc/auctex.texi | 50 +++++++++++++++++++++++++----------------------
doc/changes.texi | 2 +-
doc/install.texi | 2 +-
doc/preview-faq.texi | 5 +++++
doc/preview-problems.texi | 5 +++++
doc/preview-readme.texi | 5 +++++
doc/preview-todo.texi | 5 +++++
doc/quickstart.texi | 2 +-
doc/todo.texi | 2 +-
latex/preview.dtx | 2 +-
10 files changed, 52 insertions(+), 28 deletions(-)
diff --git a/doc/auctex.texi b/doc/auctex.texi
index 087d1405..d00ec36d 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -3298,7 +3298,7 @@ Another possibility is to use file local additions at the
end of your
@TeX{} file, e.g.:
@example
%%% Local Variables:
-%%% mode: latex
+%%% mode: LaTeX
%%% TeX-master: t
%%% eval: (TeX-ispell-skip-setcar '(("\\\\mymacro" . "@{[-0-9]+@}")))
%%% End:
@@ -4102,7 +4102,7 @@ documents and all files in a multifile document. For
example,
@example
%%% Local Variables:
-%%% mode: latex
+%%% mode: LaTeX
%%% TeX-output-dir: "build"
%%% End:
@end example
@@ -4231,26 +4231,26 @@ order. (As an exception, Texinfo mode does not run
@code{TeX-mode-hook}.)
The following table provides an overview of the respective mode
functions and hooks.
-@multitable {Plain @TeX{}} {@code{plain-tex-mode}} {@code{plain-TeX-mode-hook}}
+@multitable {Plain @TeX{}} {@code{plain-TeX-mode}} {@code{plain-TeX-mode-hook}}
@headitem Type @tab Mode function @tab Hook
-@item Plain @TeX{} @tab @code{plain-tex-mode} @tab @code{plain-TeX-mode-hook}
-@item @LaTeX{} @tab @code{latex-mode} @tab @code{LaTeX-mode-hook}
-@item AMS-@TeX{} @tab @code{ams-tex-mode} @tab @code{AmS-TeX-mode-hook}
-@item @ConTeXt{} @tab @code{context-mode} @tab @code{ConTeXt-mode-hook}
-@item Texinfo @tab @code{texinfo-mode} @tab @code{Texinfo-mode-hook}
-@item Doc@TeX{} @tab @code{doctex-mode} @tab @code{docTeX-mode-hook}
+@item Plain @TeX{} @tab @code{plain-TeX-mode} @tab @code{plain-TeX-mode-hook}
+@item @LaTeX{} @tab @code{LaTeX-mode} @tab @code{LaTeX-mode-hook}
+@item AMS-@TeX{} @tab @code{AmSTeX-mode} @tab @code{AmSTeX-mode-hook}
+@item @ConTeXt{} @tab @code{ConTeXt-mode} @tab @code{ConTeXt-mode-hook}
+@item Texinfo @tab @code{Texinfo-mode} @tab @code{Texinfo-mode-hook}
+@item Doc@TeX{} @tab @code{docTeX-mode} @tab @code{docTeX-mode-hook}
@end multitable
-@findex plain-tex-mode
+@findex plain-TeX-mode
@vindex plain-TeX-mode-hook
-@findex latex-mode
+@findex LaTeX-mode
@vindex LaTeX-mode-hook
-@findex ams-tex-mode
-@vindex AmS-TeX-mode-hook
-@findex context-mode
+@findex AmSTeX-mode
+@vindex AmSTeX-mode-hook
+@findex ConTeXt-mode
@vindex ConTeXt-mode-hook
-@findex texinfo-mode
+@findex Texinfo-mode
@vindex Texinfo-mode-hook
-@findex doctex-mode
+@findex docTeX-mode
@vindex docTeX-mode-hook
If you need to make a customization via a hook which is only relevant
@@ -4259,6 +4259,10 @@ if it is relevant for any @AUCTeX{} mode, add it to
@code{TeX-mode-hook}
and if it is relevant for all text modes, append it to
@code{text-mode-hook}.
+Now doc@TeX{} mode is child of @LaTeX{} mode, so doc@TeX{} mode runs
+@code{LaTeX-mode-hook} as well. Similarly, AmS@TeX{} mode is child of plain
+@TeX{} mode and runs @code{plain-TeX-mode-hook} as well.
+
Other useful hooks are listed below.
@defvr Variable TeX-after-compilation-finished-functions
@@ -4861,15 +4865,15 @@ If nil do it the other way round.
@vindex TeX-engine
@vindex TeX-engine-alist
@vindex japanese-TeX-mode
-@findex japanese-plain-tex-mode
-@findex japanese-latex-mode
+@findex japanese-plain-TeX-mode
+@findex japanese-LaTeX-mode
To write Japanese text with @AUCTeX{}, you need the versions of
@TeX{} and Emacs that support Japanese. @AUCTeX{} supports three
Japanese @TeX{} engines by default: NTT j@TeX{}, ASCII p@TeX{} and
up@TeX{}.
-Activate @code{japanese-plain-tex-mode} or @code{japanese-latex-mode} to
+Activate @code{japanese-plain-TeX-mode} or @code{japanese-LaTeX-mode} to
use the Japanese @TeX{} engines. If it doesn't work, send mail to
Masayuki Ataka @email{masayuki.ataka@@gmail.com} or Ikumi Keita
@email{ikumikeita@@jcom.home.ne.jp}, who currently concern with stuff
@@ -4877,7 +4881,7 @@ related to Japanese in @AUCTeX{}. None of the primary
@AUCTeX{}
maintainers understand Japanese, so they cannot help you.
It is recommended to enable @code{TeX-parse-self} for typical Japanese
-@LaTeX{} users. When enabled, @code{japanese-latex-mode} selects the
+@LaTeX{} users. When enabled, @code{japanese-LaTeX-mode} selects the
suitable Japanese @TeX{} engine automatically based on the class file
name (such as @code{jbook}, @code{jsarticle} and @code{tjreport}) and
its option. @xref{Parsing Files}.
@@ -4911,7 +4915,7 @@ Here is a sample code to set @code{TeX-engine} to
@samp{uptex}:
@example
%%% Local Variables:
-%%% mode: japanese-latex
+%%% mode: japanese-LaTeX
%%% TeX-engine: uptex
%%% End:
@end example
@@ -4942,7 +4946,7 @@ file is plain @TeX{} or @LaTeX{} or what.
If you want to enter Japanese @LaTeX{} mode whenever this may happen,
set the variable like this:
@lisp
-(setq TeX-default-mode 'japanese-latex-mode)
+(setq TeX-default-mode 'japanese-LaTeX-mode)
@end lisp
@end defopt
@@ -6307,7 +6311,7 @@ used by @AUCTeX{} for sectioning.
@bye
@c Local Variables:
-@c mode: texinfo
+@c mode: Texinfo
@c coding: utf-8
@c TeX-master: t
@c End:
diff --git a/doc/changes.texi b/doc/changes.texi
index cbb341c6..d4b54c92 100644
--- a/doc/changes.texi
+++ b/doc/changes.texi
@@ -1751,6 +1751,6 @@ Bug fixes.
@end itemize
@c Local Variables:
-@c mode: texinfo
+@c mode: Texinfo
@c TeX-master: "auctex"
@c End:
diff --git a/doc/install.texi b/doc/install.texi
index f808135b..cb5b4134 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -623,6 +623,6 @@ set the variable for you if it could use the program
@command{kpsewhich}.
In this case you normally don't have to alter anything.
@c Local Variables:
-@c mode: texinfo
+@c mode: Texinfo
@c TeX-master: "auctex"
@c End:
diff --git a/doc/preview-faq.texi b/doc/preview-faq.texi
index 3b983bf1..8421660f 100644
--- a/doc/preview-faq.texi
+++ b/doc/preview-faq.texi
@@ -304,3 +304,8 @@ file looking like the following:
\end@{plain@}
\end@{document@}
@end example
+
+@c Local Variables:
+@c mode: Texinfo
+@c TeX-master: "preview-latex"
+@c End:
diff --git a/doc/preview-problems.texi b/doc/preview-problems.texi
index 0f1518bf..57a1a185 100644
--- a/doc/preview-problems.texi
+++ b/doc/preview-problems.texi
@@ -204,3 +204,8 @@ rendered as black in the preview images, so it's almost
impossible to read
them on dark background. Hence Xe@LaTeX{} users who like dark background
in Emacs frame should customize @code{preview-pdf-adjust-color-method} to
@code{nil}.
+
+@c Local Variables:
+@c mode: Texinfo
+@c TeX-master: "preview-latex"
+@c End:
diff --git a/doc/preview-readme.texi b/doc/preview-readme.texi
index 8d4c5651..079fe089 100644
--- a/doc/preview-readme.texi
+++ b/doc/preview-readme.texi
@@ -227,3 +227,8 @@ to show your appreciation with a donation to the main
developer, you can
do so via PayPal to @email{dak@@gnu.org}, and of course you can arrange
for service contracts or for added functionality. Take a look at the
@file{TODO} list for suggestions in that area.
+
+@c Local Variables:
+@c mode: Texinfo
+@c TeX-master: "preview-latex"
+@c End:
diff --git a/doc/preview-todo.texi b/doc/preview-todo.texi
index 485373ee..ce2236b1 100644
--- a/doc/preview-todo.texi
+++ b/doc/preview-todo.texi
@@ -116,3 +116,8 @@ replace the whole color and image handling with
@acronym{GDK} routines
when this library is available, since it has been optimized for it.
@end itemize
+
+@c Local Variables:
+@c mode: Texinfo
+@c TeX-master: "preview-latex"
+@c End:
diff --git a/doc/quickstart.texi b/doc/quickstart.texi
index 9731d15e..a9c7343f 100644
--- a/doc/quickstart.texi
+++ b/doc/quickstart.texi
@@ -322,6 +322,6 @@ files. It will run @command{latex} only on the current
buffer, using the
preamble from the master file.
@c Local Variables:
-@c mode: texinfo
+@c mode: Texinfo
@c TeX-master: "auctex"
@c End:
diff --git a/doc/todo.texi b/doc/todo.texi
index 6819ce17..a0931307 100644
--- a/doc/todo.texi
+++ b/doc/todo.texi
@@ -341,6 +341,6 @@ Correct indentation for tabbing, table, and math
environments.
@end itemize
@c Local Variables:
-@c mode: texinfo
+@c mode: Texinfo
@c TeX-master: "auctex"
@c End:
diff --git a/latex/preview.dtx b/latex/preview.dtx
index c68ea264..a1fc50d7 100644
--- a/latex/preview.dtx
+++ b/latex/preview.dtx
@@ -1891,7 +1891,7 @@ Please complain to your document class author}%
% \Finale{}
% \iffalse
% Local Variables:
-% mode: doctex
+% mode: docTeX
% TeX-master: "preview.drv"
% End:
% \fi
