branch: main
commit eb9a9dca71ce20048668f50a286b6463890d0723
Author: Ikumi Keita <ik...@ikumi.que.jp>
Commit: Ikumi Keita <ik...@ikumi.que.jp>
Documentation cleanups
* GNUmakefile: Make "make clean" actually remove generated info files.
* doc/auctex.texi (Fontification of macros, Selecting a Command):
(I/O Correlation):
Prefer `with-eval-after-load' over `eval-after-load' in code examples.
* doc/auctex.texi (Folding, Selecting a Command): Improve usage of @var.
(European): Fix typo.
* doc/install.texi (Customizing): Improve markup.
* doc/preview-readme.texi: Simplify.
* doc/quickstart.texi (Editing Facilities): Fix indent.
(Processing Facilities): Fix spacing and typo.
---
GNUmakefile | 11 +++++-----
doc/auctex.texi | 57 ++++++++++++++++++++++++-------------------------
doc/install.texi | 2 +-
doc/preview-readme.texi | 14 ++++--------
doc/quickstart.texi | 6 +++---
5 files changed, 41 insertions(+), 49 deletions(-)
diff --git a/GNUmakefile b/GNUmakefile
index ad663a56..fd9948f2 100644
--- a/GNUmakefile
+++ b/GNUmakefile
@@ -27,7 +27,7 @@ PDFLATEX=pdfla$(TEX)
PDFTEX=pdf$(TEX)
MANUALS=auctex preview-latex
-INFO_FILES=$(MANUALS:=.info)
+INFO_FILES:=$(addprefix doc/, $(MANUALS:=.info))
TEXMFGEN:=$(shell sed -n
's/^%<installer>.*file[{]\([^}.]*\.[sdc][tef][yfg]\)[}].*/\1/p'
latex/preview.dtx)
LATEX_FILES:=$(patsubst %, latex/%, $(shell echo $$(echo "$(TEXMFGEN)")))
@@ -40,7 +40,7 @@ MAIN_GENERATED_FILES=README \
$(LATEX_FILES)
ALL_GENERATED_FILES=$(MAIN_GENERATED_FILES) \
- dir \
+ doc/dir \
$(INFO_FILES)
# Generate & compile everything including the manuals below doc/.
@@ -86,7 +86,6 @@ elpa: $(MAIN_GENERATED_FILES) ChangeLog
clean:
rm -f $(ALL_GENERATED_FILES) \
$(wildcard *.elc style/*.elc) \
- $(LATEX_FILES) \
$(wildcard latex/*.aux latex/*.drv latex/*.hd latex/*.log) \
$(wildcard latex/*.out latex/*.pdf latex/*.tar.gz) \
latex/preview-mk.ins latex/preview.ins \
@@ -141,11 +140,11 @@ doc/tex-ref.pdf: doc/tex-ref.tex
# Copied&adapted from doc/Makefile.in.
TEXI_SOURCES:=$(wildcard doc/*.texi) doc/version.texi doc/preview-dtxdoc.texi
-$(INFO_FILES): %.info: $(TEXI_SOURCES)
+$(INFO_FILES): doc/%.info: $(TEXI_SOURCES)
cd doc; $(MAKEINFO) --no-split $*.texi
-dir: $(INFO_FILES)
- for f in $(INFO_FILES); do $(INSTALL_INFO) --info-dir=doc doc/$$f; done
+doc/dir: $(INFO_FILES)
+ for f in $(INFO_FILES); do $(INSTALL_INFO) --info-dir=doc $$f; done
$(LATEX_FILES): latex/preview.dtx latex/bootstrap.ins
cd latex; $(TEX) '\nonstopmode \input bootstrap.ins'
diff --git a/doc/auctex.texi b/doc/auctex.texi
index cb0c0ce6..c8075187 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -2339,12 +2339,12 @@ to remove highlighting of footnotes as references you
can put the
following stanza into your init file:
@lisp
-(eval-after-load "font-latex"
- '(setq-default
- font-latex-match-reference-keywords-local
- (remove (assoc-string "footnote"
- font-latex-match-reference-keywords-local)
- font-latex-match-reference-keywords-local)))
+(with-eval-after-load 'font-latex
+ (setq-default
+ font-latex-match-reference-keywords-local
+ (remove (assoc-string "footnote"
+ font-latex-match-reference-keywords-local)
+ font-latex-match-reference-keywords-local)))
@end lisp
But note that this means fiddling with @fontlatex{}'s internals and is
@@ -2851,11 +2851,11 @@ original source text.
@item
@code{nil}: @AUCTeX{} never reveals.
@item
-@var{SYMBOL}: The value of @var{SYMBOL} is used as a boolean flag. If
-@var{SYMBOL} isn't bound as a variable, it is treated as @code{nil}.
+@var{symbol}: The value of @var{symbol} is used as a boolean flag. If
+@var{symbol} isn't bound as a variable, it is treated as @code{nil}.
@item
-Cons cell @code{(@var{FUNCTION} . @var{ARGUMENTS})}: @AUCTeX{} calls the
-@var{FUNCTION} with arbitrary number of @var{ARGUMENTS}. The return value
+Cons cell @code{(@var{function} . @var{arguments})}: @AUCTeX{} calls the
+@var{function} with arbitrary number of @var{arguments}. The return value
is regarded as a boolean flag.
@end itemize
@@ -3208,10 +3208,10 @@ example, if you wanted to add a command for running a
program called
following form.
@lisp
-(eval-after-load "tex"
- '(add-to-list 'TeX-command-list
- '("Foo" "foo %s" TeX-run-command t t :help "Run foo")
- t))
+(with-eval-after-load 'tex
+ (add-to-list 'TeX-command-list
+ '("Foo" "foo %s" TeX-run-command t t :help "Run foo")
+ t))
@end lisp
As mentioned before, @AUCTeX{} will try to guess what command you want
@@ -3316,12 +3316,12 @@ line:
@lisp
("\\\\addcontentsline" ispell-tex-arg-end 2)
@end lisp
-@code{KEY} is the string @code{"\\\\addcontentsline"}, @code{FUNCTION}
-is @code{ispell-tex-arg-end} called with @code{ARGS}, here @code{2}.
+@var{key} is the string @code{"\\\\addcontentsline"}, @var{function}
+is @code{ispell-tex-arg-end} called with @var{args}, here @code{2}.
@code{ispell-tex-arg-end} is a function provided by @file{ispell.el}
which skips as many subsequent optional arguments in square brackets as
-it sees and then skips @code{ARGS} number of mandatory arguments in
-braces. Omitting @code{ARGS} means skip @code{1} mandatory argument.
+it sees and then skips @var{args} number of mandatory arguments in
+braces. Omitting @var{args} means skip @code{1} mandatory argument.
In practice, when you have something like this in your document:
@example
\addcontentsline@{toc@}@{chapter@}@{Some text@}
@@ -3346,7 +3346,7 @@ Finally, the next line
@end lisp
ensures that the entire preamble of a document is discarded. Second
list works the same; it is more convenient for environments since
-@code{KEY} is wrapped inside @code{\begin@{@}}.
+@var{key} is wrapped inside @code{\begin@{@}}.
@findex TeX-ispell-skip-setcar
@findex TeX-ispell-skip-setcdr
@@ -3356,12 +3356,11 @@ list works the same; it is more convenient for
environments since
exactly as in @code{ispell-tex-skip-alists}. Additions can be done via
init file, e.g.:
@lisp
-(eval-after-load "tex-ispell"
- '(progn
- (TeX-ispell-skip-setcar
- '(("\\\\mymacro" ispell-tex-arg-end)))
- (TeX-ispell-skip-setcdr
- '(("myverbatim" . "\\\\end@{myverbatim@}")))))
+(with-eval-after-load 'tex-ispell
+ (TeX-ispell-skip-setcar
+ '(("\\\\mymacro" ispell-tex-arg-end)))
+ (TeX-ispell-skip-setcdr
+ '(("myverbatim" . "\\\\end@{myverbatim@}"))))
@end lisp
Another possibility is to use file local additions at the end of your
@@ -3850,9 +3849,9 @@ Actually, this keymap isn't implemented as minor mode map
of
@code{TeX-source-correlate-mode}, in order that its bindings don't affect
buffers outside of @AUCTeX{}.} and @code{TeX-view-mouse} like this:
@lisp
-(eval-after-load "tex"
- '(define-key TeX-source-correlate-map [C-down-mouse-1]
- #'TeX-view-mouse))
+(with-eval-after-load 'tex
+ (define-key TeX-source-correlate-map [C-down-mouse-1]
+ #'TeX-view-mouse))
@end lisp
This example binds @kbd{C-down-mouse-1}, which usually opens a concise
menu to select buffer, to the command to do forward search.
@@ -4904,7 +4903,7 @@ string. See the list of supported languages above. The
second item is
the opening quotation mark. The third item is the closing quotation mark.
Opening and closing quotation marks can be specified directly as strings
or as functions returning a string. The fourth item is a boolean
-controlling quote insertion. It should be non-@code{nil} if if the
+controlling quote insertion. It should be non-@code{nil} if the
special quotes should only be used after inserting a literal @samp{"}
character first, i.e.@: on second key press.
@end defopt
diff --git a/doc/install.texi b/doc/install.texi
index 5a00f8c3..f76a85d3 100644
--- a/doc/install.texi
+++ b/doc/install.texi
@@ -637,7 +637,7 @@ should not be done anymore because the installation routine
will
overwrite those changes.
You might check some options with a special significance. They are
-accessible directly by typing @kbd{M-x customize-option @key{RET} <option>
+accessible directly by typing @kbd{M-x customize-option @key{RET} @var{option}
@key{RET}}.
@defopt TeX-macro-global
diff --git a/doc/preview-readme.texi b/doc/preview-readme.texi
index 079fe089..c404d005 100644
--- a/doc/preview-readme.texi
+++ b/doc/preview-readme.texi
@@ -76,8 +76,7 @@ possible cause are duplicate Lisp files that might be
detectable with
@section Getting started
Once activated, @previewlatex{} and its documentation will be accessible
-via its menus (note that @previewlatex{} requires @AUCTeX{} to be
-loaded). When you have loaded a @LaTeX{} document (a
+via its menus. When you have loaded a @LaTeX{} document (a
sample document @file{circ.tex} is included in the distribution, but
most documents including math and/or figures should do), you can use
its menu or @kbd{C-c C-p C-d} (for @samp{Preview/Document}).
@@ -133,10 +132,8 @@ setting is @samp{dvipng} in case you have the @samp{dvipng}
program installed. In this case, @samp{dvipng} will be used for
converting @acronym{DVI} files and Ghostscript (with a @samp{PNG}
device) for converting @acronym{PDF} files. @samp{dvipng} is much
-faster than the combination of Dvips and Ghostscript. You can get
-downloads, access to its @acronym{CVS} archive and further information
-from its @uref{https://savannah.nongnu.org/projects/dvipng, project
-site}.
+faster than the combination of Dvips and Ghostscript. @samp{dvipng} is
+included in standard @w{TeX Live} distribution.
@node More documentation, Availability, Basic modes of operation, Introduction
@section More documentation
@@ -191,10 +188,7 @@ will display it.
The @previewlatex{} project is now part of @AUCTeX{} and accessible as
part of the @uref{https://savannah.gnu.org/projects/auctex,@AUCTeX{}
-project page}. You can get its files from the
-@uref{https://ftp.gnu.org/pub/gnu/auctex/,@AUCTeX{} download area}. As of
-@w{@AUCTeX{} 11.81}, @previewlatex{} should already be integrated into
-@AUCTeX{}, so no separate download will be necessary.
+project page}.
Anonymous Git is available at @uref{git://git.savannah.gnu.org/auctex.git}
or @uref{https://git.savannah.gnu.org/git/auctex.git}. You can also
diff --git a/doc/quickstart.texi b/doc/quickstart.texi
index 8f5f7ac0..e1fcac7e 100644
--- a/doc/quickstart.texi
+++ b/doc/quickstart.texi
@@ -54,7 +54,7 @@ document structure. You can do this by inserting
@lisp
(setq-default TeX-master nil)
@end lisp
-
+@noindent
into your init file. Each time you open a new file, @AUCTeX{} will then
ask you for a master file.
@@ -288,7 +288,7 @@ you type @kbd{C-C C-c}. For details, see @ref{Processor
Options}.
When @AUCTeX{} runs a program, it creates an output buffer in which it
displays the output of the command. If there is a syntactical error in
-your file, @command{latex} will not complete successfully. @AUCTeX{}
+your file, @command{latex} will not complete successfully. @AUCTeX{}
will tell you that, and you can get to the place where the first error
occured by pressing @kbd{C-c `} (the last character is a backtick). The
view will be split in two windows, the output will be displayed in the
@@ -296,7 +296,7 @@ lower buffer, and both buffers will be centered around the
place where
the error ocurred. You can then try to fix it in the document buffer,
and use the same keystrokes to get to the next error. This procedure
may be repeated until all errors have been dealt with. By pressing
-@kbd{C-c C-w} (@code{TeX-toggle-debug-boxes}) you can toggle whether
+@kbd{C-c C-w} (@code{TeX-toggle-debug-bad-boxes}) you can toggle whether
@AUCTeX{} should notify you of overfull and underfull boxes in addition
to regular errors.
