Info-validate: Some observations and questions
Hello \(tex\)?info experts!
Another big texi patch from me is lurking around the corner, so
beware!
Using
C-u M-x texinfo-format-buffer
M-x Info-tagify
M-x Info-validate
I found some problems with Info-validate.
1. I fixed a bug which caused Info-validate to misunderstand " Menu"
in the middle of a line as the start of a proper Menu. Non-Errors
where genereated as a result.
2. xrefs containing spaces may be folded during paragraph filling in
`texinfo-format-buffer'. This will cause false "invalid reference
..." errors.
I have fixed this problem by replacing "[ \t]+" inside reference
names with single spaces.
Q: Is this the Right Thing to do?
3. Info-validate complains about (at least) the following invalid
references. All of these are not real xrefs but rather `Notes'
written in the texi sources. Constructs as ＠strong{Note:} and
＠emph{NOTE:} are wrong according to the Texinfo manual:
*Caution:* Do not use `＠emph' or `＠strong' with the word `Note';
Info will mistake the combination for a cross reference. Use a
phrase such as *Please note* or *Caution* instead.
Q: Is it acceptable if I change all occurences from ...{note.?} to
...{[Pp]lease note.?}?
The '{note' occurences:
cd /u/aichner/tmp/xemacs-20/man/
find . -type d \( -name SCCS -o -name RCS \) -prune -o \( -type f -o -type l \) -name
"*.texi" -exec egrep -n -i '{note' "{}" /dev/null \;
Compilation started at Wed Jun 17 19:38:13 1998
./cl.texi:3224:＠strong{Note:} This declaration remains in effect after the
./info-stnd.texi:626:＠dfn{menu} references, and ＠dfn{note} references. Menu references
./standards.texi:1340:Used in many programs to inhibit the usual output. ＠strong{Note:}
every
./standards.texi:1455:＠strong{Note:} every program accepting
./texinfo.texi:703:＠dfn{Texinfo}＠footnote{Note that the first syllable of
``Texinfo'' is
./texinfo.texi:6892:word ＠samp{Note}; Info will mistake the combination for a cross
./xemacs-faq.texi:2799:＠strong{NOTE:} The single minibuffer frame may not be to
everyone's
./internals/internals.texi:1698: ＠strong{Note:} This kludge only works on a few systems
nowadays, and is
./internals/internals.texi:1987: ＠strong{Note:} It is potentially deadly if you declare a
＠samp{Q...}
./internals/internals.texi:4329:＠strong{Note}: When the mark method is called, garbage
collection
./lispref/buffers.texi:656:;; ＠r{Note that the name of the minibuffer}
./lispref/compile.texi:486:＠emph{NOTE:} Unlike all other Emacs-lisp functions, calling
this with
./lispref/debugging.texi:193: ＠strong{Note:} if you redefine a function after using
./lispref/eval.texi:112: ＠strong{Note:} it is generally cleaner and more flexible to
call
./lispref/extents.texi:48: ＠emph{NOTE}: An alternative way to add properties to a buffer
or
./lispref/loading.texi:650:＠strong{NOTE}: The advanced arguments of this function
(anything other than a
./lispref/text.texi:1431:;; ＠r{Note that the first two lines of doc string}
./lispref/variables.texi:1090:＠strong{Note:} do not use ＠code{make-local-variable} for a
hook
igrep finished at Wed Jun 17 19:38:38
and the resulting damage (bad xrefs "*Note:*"):
cd /export/home/tmp/xemacs-21.0-b44/info/
egrep -ni '\*Note:' *.info* /dev/null
Compilation started at Wed Jun 17 19:29:19 1998
cl.info-3:757: *Note:* This declaration remains in effect after the containing
internals.info-2:564: *Note:* This kludge only works on a few systems nowadays, and is
internals.info-2:838: *Note:* It is potentially deadly if you declare a `Q...'
variable
lispref.info-12:253: *NOTE:* Unlike all other Emacs-lisp functions, calling this with
lispref.info-12:683: *Note:* if you redefine a function after using
`debug-on-entry' on
lispref.info-7:1120: *Note:* it is generally cleaner and more flexible to call
functions
lispref.info-9:1045: *Note:* do not use `make-local-variable' for a hook
variable.
standards.info-1:1282: Used in many programs to inhibit the usual output. *Note:*
every
standards.info-1:1394: Used in many programs to inhibit the usual output. *Note:*
every
xemacs-faq.info-3:258: *NOTE:* The single minibuffer frame may not be to everyone's
taste,
Please advise,
Adrian
--
Adrian Aichner
Applications Engineer
Teradyne GmbH
Semiconductor Test Group Telephone +49/89/41861(0)-208
Dingolfinger Strasse 2 Fax +49/89/41861-217
D-81673 MUENCHEN E-mail aichner(a)ecf.teradyne.com