[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
From: |
karl |
Subject: |
texinfo ChangeLog doc/texinfo.txi |
Date: |
Tue, 15 Jan 2013 00:19:59 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: karl <karl> 13/01/15 00:19:59
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
more node names with @
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1516&r2=1.1517
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.524&r2=1.525
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1516
retrieving revision 1.1517
diff -u -b -r1.1516 -r1.1517
--- ChangeLog 14 Jan 2013 19:45:35 -0000 1.1516
+++ ChangeLog 15 Jan 2013 00:19:58 -0000 1.1517
@@ -1,7 +1,9 @@
2013-01-14 Karl Berry <address@hidden>
- * doc/texinfo.txi (Conditionally Visible Text, Defining New
- Texinfo Commands): node names with @.
+ * doc/texinfo.txi (Conditionally Visible Text,
+ Defining New Texinfo Commands,
+ Formatting and Printing Hardcopy,
+ Creating an Info File): node names with @.
Fix more xrefs for new names.
2013-01-13 Karl Berry <address@hidden>
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.524
retrieving revision 1.525
diff -u -b -r1.524 -r1.525
--- doc/texinfo.txi 14 Jan 2013 19:45:35 -0000 1.524
+++ doc/texinfo.txi 15 Jan 2013 00:19:59 -0000 1.525
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.524 2013/01/14 19:45:35 karl Exp $
address@hidden $Id: texinfo.txi,v 1.525 2013/01/15 00:19:59 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -158,7 +158,7 @@
* Include Files:: How to incorporate other Texinfo files.
* Hardcopy:: Output for paper, with @TeX{}.
-* Generic Translator texi2any:: @command{texi2any}, an all-purpose converter.
+* Generic Translator @code{texi2any}:: @command{texi2any}, an all-purpose
converter.
* Creating and Installing Info Files:: Details on Info output.
* Generating HTML:: Details on HTML output.
@c * texi2any Output Customization:: Fine tuning with initialization files.
@@ -288,7 +288,7 @@
Nodes
* @code{@@node}:: Creating nodes, in detail.
-* @code{@@makeinfo} Pointer Creation:: Letting makeinfo determine node
pointers.
+* @code{makeinfo} Pointer Creation:: Letting makeinfo determine node
pointers.
* @code{@@anchor}:: Defining arbitrary cross reference
targets.
* Node Menu Illustration:: A diagram, and sample nodes and menus.
@@ -582,7 +582,7 @@
* Requirements Summary:: @TeX{} formatting requirements summary.
* Preparing for @TeX{}:: What to do before you use @TeX{}.
* Overfull hboxes:: What are and what to do with overfull hboxes.
-* smallbook:: How to print small format books and manuals.
+* @code{@@smallbook}:: How to print small format books and
manuals.
* A4 Paper:: How to print on A4 or A5 paper.
* @code{@@pagesizes}:: How to print with customized page sizes.
* Cropmarks and Magnification:: How to print marks to indicate the size
@@ -593,12 +593,12 @@
@command{texi2any}: The Generic Translator for Texinfo
* Reference Implementation:: @command{texi2any}: the reference implementation.
-* Invoking texi2any:: Running the translator from a shell.
-* texi2any Printed Output:: Calling @command{texi2dvi}.
+* Invoking @code{texi2any}:: Running the translator from a shell.
+* @code{texi2any} Printed Output:: Calling @code{texi2dvi}.
* Pointer Validation:: How to check that pointers point somewhere.
-* Customization Variables:: Configuring @command{texi2any}.
+* Customization Variables:: Configuring @code{texi2any}.
* Internationalization of Document Strings:: Translating program-inserted text.
-* texi2html:: An ancestor of @command{texi2any}.
+* @code{texi2html}:: An ancestor of @code{texi2any}.
Customization Variables
@@ -614,9 +614,9 @@
Creating an Info File
-* makeinfo advantages:: @code{makeinfo} provides better error checking.
-* makeinfo in Emacs:: How to run @code{makeinfo} from Emacs.
-* texinfo-format commands:: Two Info formatting commands written
+* @code{makeinfo} advantages:: @code{makeinfo} provides better error
checking.
+* @code{makeinfo} in Emacs:: How to run @code{makeinfo} from Emacs.
+* @code{texinfo-format} commands:: Two Info formatting commands written
in Emacs Lisp are an alternative
to @code{makeinfo}.
* Batch Formatting:: How to format for Info in Emacs Batch mode.
@@ -671,7 +671,7 @@
Catching Mistakes
-* makeinfo Preferred:: @code{makeinfo} finds errors.
+* @code{makeinfo} Preferred:: @code{makeinfo} finds errors.
* Debugging with Info:: How to catch errors with Info formatting.
* Debugging with @TeX{}:: How to catch errors with @TeX{} formatting.
* Using texinfo-show-structure:: How to use @code{texinfo-show-structure}.
@@ -1040,8 +1040,7 @@
to write a new back-end for @command{texi2any}, our reference
implementation of a Texinfo parser; it creates a tree representation
of the Texinfo input that you can use for the conversion.
address@hidden Translator texi2any,, @command{texi2any}: The Generic
-Translator}.
address@hidden Translator @code{texi2any}}.
Another viable approach is use the Texinfo XML output from
@command{texi2any} as your input. This XML is an essentially complete
@@ -1128,8 +1127,7 @@
Info files are nearly always created by processing a Texinfo source
document. @command{makeinfo}, also known as @command{texi2any}, is
the principal command that converts a Texinfo file into an Info file;
address@hidden Translator texi2any,, @command{texi2any}: The Generic
-Translator}.
address@hidden Translator @code{texi2any}}.
Generally, you enter an Info file through a node that by convention is
named `Top'. This node normally contains just a brief summary of the
@@ -1194,8 +1192,8 @@
11 inch pages (address@hidden by address@hidden); this is the default size.
But you can also print for 7 inch by 9.25 inch pages (address@hidden by
address@hidden, the @code{@@smallbook} size; or on A4 or A5 size paper
-(@code{@@afourpaper}, @code{@@afivepaper}). @xref{smallbook,,
-Printing ``Small'' Books}, and @ref{A4 Paper,, Printing on A4 Paper}.
+(@code{@@afourpaper}, @code{@@afivepaper}).
address@hidden@code{@@smallbook}}, and @ref{A4 Paper}.
@cindex Literate programming
@TeX{} is freely distributable. It is written in a superset of Pascal
@@ -2980,7 +2978,8 @@
Header}).
The start- and end-of-header lines allow you to format only part of a
-Texinfo file for Info or printing. @xref{texinfo-format commands}.
+Texinfo file for Info or printing. @address@hidden
+commands}.
The odd string of characters, @samp{%**}, is to ensure that no other
comment is accidentally taken for a start-of-header line. You can
@@ -3062,7 +3061,7 @@
when generating Info, etc. The @code{\input} line is still ignored in
this processing, as well as leading blank lines.
-See also the @option{--output} option in @ref{Invoking texi2any}.
+See also the @option{--output} option in @ref{Invoking @code{texi2any}}.
@node @code{@@settitle}
@@ -7949,10 +7948,10 @@
The effect is to reduce the body font to a address@hidden size (the
default is address@hidden). Fonts for other elements, such as sections
and chapters, are reduced accordingly. This should only be used in
-conjunction with @code{@@smallbook} (@pxref{smallbook,, Printing
-``Small'' Books}) or similar, since address@hidden fonts on standard paper
-(8.5x11 or A4) are too small. One reason to use this command is to
-save pages, and hence printing cost, for physical books.
+conjunction with @code{@@smallbook} (@address@hidden@@smallbook}}) or
+similar, since address@hidden fonts on standard paper (8.5x11 or A4) are
+too small. One reason to use this command is to save pages, and hence
+printing cost, for physical books.
Texinfo does not at present have commands to switch the font family
to use, or more general size-changing commands.
@@ -15280,9 +15279,9 @@
@item
If you run @command{makeinfo} or its variants (@pxref{Generic
-Translator texi2any,, @command{texi2any}: The Generic Translator}),
-you can specify @option{--no-ifinfo --iftex -E somefile.out}, and then
-give @file{somefile.out} to @code{texi2dvi} in a separate command.
+Translator @code{texi2any}}), you can specify @option{--no-ifinfo
+--iftex -E somefile.out}, and then give @file{somefile.out} to
address@hidden in a separate command.
@item
Or you can run @option{makeinfo --dvi --Xopt -E}. (Or @option{--pdf}
@@ -15297,8 +15296,8 @@
@TeX{} itself, are the (incorrect) line numbers from the derived file
which @TeX{} is reading, rather than the preprocessor-specified line
numbers. This is another example of why we recommend running
address@hidden for the best diagnostics (@pxref{makeinfo
-advantages,, @code{makeinfo} Advantages}).
address@hidden for the best diagnostics (@address@hidden
+Advantages}).
@node #line Syntax Details
@@ -15647,7 +15646,7 @@
* Requirements Summary:: @TeX{} formatting requirements summary.
* Preparing for @TeX{}:: What to do before you use @TeX{}.
* Overfull hboxes:: What are and what to do with overfull hboxes.
-* smallbook:: How to print small format books and manuals.
+* @code{@@smallbook}:: How to print small format books and
manuals.
* A4 Paper:: How to print on A4 or A5 paper.
* @code{@@pagesizes}:: How to print with customized page sizes.
* Cropmarks and Magnification:: How to print marks to indicate the size
@@ -15656,6 +15655,7 @@
* Obtaining @TeX{}:: How to obtain @TeX{}.
@end menu
+
@node Use @TeX{}
@section Use @TeX{}
@@ -15828,7 +15828,7 @@
This inserts @var{cmd} on a line by itself after the
@code{@@setfilename} in a temporary copy of the input file before
running @TeX{}. With this, you can specify different printing
-formats, such as @code{@@smallbook} (@pxref{smallbook}),
+formats, such as @code{@@smallbook} (@address@hidden@@smallbook}}),
@code{@@afourpaper} (@pxref{A4 Paper}), or @code{@@pagesizes}
(@address@hidden@@pagesizes}}), without actually changing the document
source. (You can also do this on a site-wide basis with
@@ -16408,8 +16408,10 @@
@end example
address@hidden smallbook
address@hidden Printing ``Small'' Books
address@hidden @code{@@smallbook}
address@hidden @code{@@smallbook}: Printing ``Small'' Books
+
address@hidden@c old name
@findex smallbook
@cindex Small book size
@cindex Book, printing small
@@ -16644,8 +16646,8 @@
@c please keep that text in sync with www.gnu.org/prep/FTP
address@hidden Generic Translator texi2any
address@hidden @command{texi2any}: The Generic Translator for Texinfo
address@hidden Generic Translator @code{texi2any}
address@hidden @code{texi2any}: The Generic Translator for Texinfo
@command{texi2any} is the generic translator for Texinfo that can
produce different output formats and is highly customizable. It
@@ -16679,12 +16681,12 @@
@menu
* Reference Implementation:: @command{texi2any}: the reference implementation.
-* Invoking texi2any:: Running the translator from a shell.
-* texi2any Printed Output:: Calling @command{texi2dvi}.
+* Invoking @code{texi2any}:: Running the translator from a shell.
+* @code{texi2any} Printed Output:: Calling @command{texi2dvi}.
* Pointer Validation:: How to check that pointers point somewhere.
* Customization Variables:: Configuring @command{texi2any}.
* Internationalization of Document Strings:: Translating program-inserted text.
-* texi2html:: An ancestor of @command{texi2any}.
+* @code{texi2html}:: An ancestor of @command{texi2any}.
@end menu
@@ -16715,10 +16717,10 @@
implementations (@pxref{History}). The current reference
implementation, @command{texi2any}, inherited the design of
customization and other features from @command{texi2html} (for more on
address@hidden compatibility, @pxref{texi2html,,
address@hidden). However, @code{texi2any} is a full
-reimplementation: it constructs a tree-based representation of the
-input document for all back-ends to work from.
address@hidden compatibility, @address@hidden).
+However, @code{texi2any} is a full reimplementation: it constructs a
+tree-based representation of the input document for all back-ends to
+work from.
@cindex Texinfo language tests
@cindex Tests, of Texinfo language
@@ -16728,9 +16730,9 @@
@cindex Examples of using @command{texi2any}
@findex Texinfo::Parser module
-The @command{texi2html} wrapper script (@pxref{texi2html}) provides a
-simple example of calling @command{texi2any} from a shell script; it's
-in @file{util/texi2html} in the Texinfo sources. More
+The @command{texi2html} wrapper script (@address@hidden)
+provides a simple example of calling @command{texi2any} from a shell
+script; it's in @file{util/texi2html} in the Texinfo sources. More
consequentially, @command{texi-elements-by-size} is an example Perl
script using the @code{Texinfo::Parser} module interface; it's in
@file{util/texi-elements-by-size}. (Its functionality may also be
@@ -16744,8 +16746,9 @@
@command{texi2any}.
address@hidden Invoking texi2any
address@hidden Invoking @code{texi2any}
@section Invoking @command{texi2any}/@code{makeinfo} from a Shell
+
@anchor{Invoking makeinfo}
@pindex makeinfo
@pindex texi2any
@@ -16764,7 +16767,8 @@
You can specify more than one input file name; each is processed in
turn. If an input file name is @samp{-}, standard input is read.
address@hidden options}
address@hidden@code{makeinfo} options}
address@hidden anchor{makeinfo options}
@cindex @code{makeinfo} options
@cindex Options for @code{makeinfo}
@anchor{texi2any Options}
@@ -16858,12 +16862,12 @@
@item --dvi
@opindex --dvi
Generate a TeX DVI file using @command{texi2dvi}, rather than Info
-(@pxref{texi2any Printed Output}).
+(@address@hidden Printed Output}).
@item --dvipdf
@opindex --dvipdf
Generate a PDF file using @command{texi2dvi --dvipdf}, rather than
-Info (@pxref{texi2any Printed Output}).
+Info (@address@hidden Printed Output}).
@item address@hidden
@itemx -e @var{limit}
@@ -17137,7 +17141,7 @@
@item --pdf
@opindex --pdf
Generate a PDF file using @command{texi2dvi --pdf}, rather than Info
-(@pxref{texi2any Printed Output}).
+(@address@hidden Printed Output}).
@item --plaintext
@opindex --plaintext
@@ -17158,8 +17162,8 @@
@item --ps
@opindex --ps
-Generate a PostScript file using @command{texi2dvi --ps}, rather
-than Info (@pxref{texi2any Printed Output}).
+Generate a PostScript file using @command{texi2dvi --ps}, rather than
+Info (@address@hidden Printed Output}).
@item --set-customization-variable @address@hidden
@itemx -c @address@hidden
@@ -17232,7 +17236,7 @@
@item --Xopt @var{str}
@opindex --Xopt @var{str}
Pass @var{str} (a single shell word) to @command{texi2dvi}; may be
-repeated (@pxref{texi2any Printed Output}).
+repeated (@address@hidden Printed Output}).
@item --xml
@opindex --xml
@@ -17253,8 +17257,9 @@
If not set or otherwise specified, Info output is the default.
address@hidden texi2any Printed Output
address@hidden @code{texi2any} Printed Output
@section @command{texi2any} Printed Output
+
@cindex Printed output, through @command{texi2any}
@cindex Output, printed through @command{texi2any}
@@ -17479,9 +17484,9 @@
@cindex Customization variables for options
@cindex Options, customization variables for
-The following table gives the customization variables associated
-with some command line options. @xref{Invoking
-texi2any}, for the meaning of the options.
+The following table gives the customization variables associated with
+some command line options. @xref{Invoking @code{texi2any}}, for the
+meaning of the options.
@multitable @columnfractions 0.5 0.5
@headitem Option @tab Variable
@@ -17972,7 +17977,7 @@
@item TEXI2DVI
Name of the command used to produce PostScript, PDF, and DVI; default
address@hidden @xref{texi2any Printed Output}.
address@hidden @address@hidden Printed Output}.
@item TEXI2HTML
@cindex compatibility, with @command{texi2html}
@@ -18244,8 +18249,9 @@
appropriately in many languages.
address@hidden texi2html
address@hidden @command{texi2html}: Ancestor of @command{texi2any}
address@hidden @code{texi2html}
address@hidden @code{texi2html}: Ancestor of @code{texi2any}
+
@pindex texi2html
@cindex Cons, Lionel
@@ -18365,9 +18371,9 @@
@pxref{Installing an Info File}.
@menu
-* makeinfo advantages:: @code{makeinfo} provides better error checking.
-* makeinfo in Emacs:: How to run @code{makeinfo} from Emacs.
-* texinfo-format commands:: Two Info formatting commands written
+* @code{makeinfo} Advantages:: @code{makeinfo} provides better error
checking.
+* @code{makeinfo} in Emacs:: How to run @code{makeinfo} from Emacs.
+* @code{texinfo-format} commands:: Two Info formatting commands written
in Emacs Lisp are an alternative
to @code{makeinfo}.
* Batch Formatting:: How to format for Info in Emacs Batch mode.
@@ -18376,9 +18382,11 @@
@end menu
address@hidden makeinfo advantages
address@hidden @code{makeinfo} Advantages
@subsection @code{makeinfo} Advantages
address@hidden address@hidden old name
+
The @code{makeinfo} utility creates an Info file from a Texinfo source
providing better error messages than either of the Emacs formatting
commands. We recommend it. The @code{makeinfo} program is
@@ -18391,8 +18399,10 @@
commands may be useful if you cannot run @code{makeinfo}.
address@hidden makeinfo in Emacs
address@hidden @code{makeinfo} in Emacs
@subsection Running @code{makeinfo} Within Emacs
+
address@hidden anchor{makeinfo in address@hidden old name
@cindex Running @code{makeinfo} in Emacs
@cindex @code{makeinfo} inside Emacs
@cindex Shell, running @code{makeinfo} in
@@ -18475,22 +18485,24 @@
@c Writing these three cross references using xref results in
@c three references to the same named manual, which looks strange.
@iftex
-For more information, see @ref{makeinfo options}, as well as ``Easy
-Customization Interface,'' ``Examining and Setting Variables,'' and
-``Init File'' in @cite{The GNU Emacs Manual}.
+For more information, see @address@hidden options}, as well as
+``Easy Customization Interface,'' ``Examining and Setting Variables,''
+and ``Init File'' in @cite{The GNU Emacs Manual}.
@end iftex
@ifnottex
For more information, address@hidden
@ref{Easy Customization, , Easy Customization Interface, emacs, The GNU Emacs
Manual},@*
@ref{Examining, , Examining and Setting Variables, emacs, The GNU Emacs
Manual},@*
@ref{Init File, , , emacs, The GNU Emacs Manual}, address@hidden
address@hidden options}.
address@hidden@code{makeinfo} options}.
@end ifnottex
address@hidden texinfo-format commands
address@hidden @code{texinfo-format} commands
@subsection The @address@hidden Commands
address@hidden anchor{texinfo-format address@hidden old name
+
In GNU Emacs in Texinfo mode, you can format part or all of a Texinfo
file with the @code{texinfo-format-region} command. This formats the
current region and displays the formatted text in a temporary buffer
@@ -18520,7 +18532,7 @@
provide you with further help in finding formatting errors. These
procedures are described in an appendix; see @ref{Catching Mistakes}.
However, the @code{makeinfo} program provides better error checking
-(@pxref{makeinfo in Emacs}).
+(@address@hidden in Emacs}).
@node Batch Formatting
@@ -19251,7 +19263,7 @@
(@code{thead}, @code{abbr}, @code{acronym}).
Using @samp{--init-file=html32.pm} produces strict address@hidden
-output (@pxref{Invoking texi2any}).
+output (@pxref{Invoking @code{texi2any}}).
Please report output from an error-free run of @code{makeinfo} which
has browser portability problems as a bug (@pxref{Reporting Bugs}).
@@ -19282,12 +19294,12 @@
@code{CASE_INSENSITIVE_FILENAMES}.
It is also possible to split at chapters or sections with
address@hidden (@pxref{Invoking texi2any}). In that case, the file
-names are constructed after the name of the node associated with the
-relevant sectioning command. Also, unless @option{--no-node-files} is
-specified, a redirection file is output for every node in order to
-more reliably support cross references to that manual (@pxref{HTML
-Xref}).
address@hidden (@pxref{Invoking @code{texi2any}}). In that case,
+the file names are constructed after the name of the node associated
+with the relevant sectioning command. Also, unless
address@hidden is specified, a redirection file is output
+for every node in order to more reliably support cross references to
+that manual (@pxref{HTML Xref}).
When splitting, the HTML output files are written into a subdirectory,
with the name chosen as follows:
@@ -21015,8 +21027,8 @@
@item @@smallbook
Cause @TeX{} to produce a printed manual in a 7 by 9.25 inch format
-rather than the regular 8.5 by 11 inch format. @xref{smallbook, ,
-Printing Small Books}. Also, see @address@hidden@@address@hidden
+rather than the regular 8.5 by 11 inch format.
address@hidden@code{@@smallbook}}. Also, see @address@hidden@@address@hidden
@item @@smalldisplay
Begin a kind of example. Like @code{@@display}, but use a smaller
@@ -21951,7 +21963,7 @@
as:
@example
-$Id: texinfo.txi,v 1.524 2013/01/14 19:45:35 karl Exp $
+$Id: texinfo.txi,v 1.525 2013/01/15 00:19:59 karl Exp $
@end example
(This is potentially useful in all sources that use version control,
@@ -22541,7 +22553,7 @@
command and you can use the @kbd{M-x Info-validate} command.
@menu
-* makeinfo Preferred:: @code{makeinfo} finds errors.
+* @code{makeinfo} Preferred:: @code{makeinfo} finds errors.
* Debugging with Info:: How to catch errors with Info formatting.
* Debugging with @TeX{}:: How to catch errors with @TeX{} formatting.
* Using texinfo-show-structure:: How to use @code{texinfo-show-structure}.
@@ -22550,9 +22562,11 @@
@end menu
address@hidden makeinfo Preferred
address@hidden @code{makeinfo} Preferred
@section @code{makeinfo} Preferred
address@hidden anchor{makeinfo address@hidden old name
+
The @code{makeinfo} program does an excellent job of catching errors
and reporting them---far better than @code{texinfo-format-region} or
@code{texinfo-format-buffer}. In addition, the various functions for
- texinfo ChangeLog doc/texinfo.txi, (continued)
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/05
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/06
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/07
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/07
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/08
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/12
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/13
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/13
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/14
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/14
- texinfo ChangeLog doc/texinfo.txi,
karl <=
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/18
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/20
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/21
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/25
- texinfo ChangeLog doc/texinfo.txi, karl, 2013/01/29