[Top][All Lists]

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

texinfo ChangeLog doc/texinfo.txi

From: Karl Berry
Subject: texinfo ChangeLog doc/texinfo.txi
Date: Sun, 08 Apr 2012 17:02:26 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       12/04/08 17:02:25

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        (node): both @node and sectioning cmd for TeX xrefs


Index: ChangeLog
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1342
retrieving revision 1.1343
diff -u -b -r1.1342 -r1.1343
--- ChangeLog   6 Apr 2012 18:19:01 -0000       1.1342
+++ ChangeLog   8 Apr 2012 17:02:13 -0000       1.1343
@@ -1,3 +1,8 @@
+2012-04-08  Karl Berry  <address@hidden>
+       * doc/texinfo.txi (node): explain further that TeX requires both a
+       @node line and a sectioning command to make cross references.
 2012-04-06  Karl Berry  <address@hidden>
        * doc/texinfo.tex (\crossmanualxref): new macro.

Index: doc/texinfo.txi
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.429
retrieving revision 1.430
diff -u -b -r1.429 -r1.430
--- doc/texinfo.txi     26 Feb 2012 22:01:47 -0000      1.429
+++ doc/texinfo.txi     8 Apr 2012 17:02:23 -0000       1.430
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.429 2012/02/26 22:01:47 pertusus Exp $
address@hidden $Id: texinfo.txi,v 1.430 2012/04/08 17:02:23 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.
@@ -5066,10 +5066,12 @@
 a line, and follow it with up to four arguments, separated by commas,
 on the rest of the same line.  The first argument is required; it is
 the name of this node (for details of node names, @pxref{Node Line
-Requirements}).  The subsequent arguments are the names of the `Next',
-`Previous', and `Up' pointers, in that order, and may be omitted if
-your Texinfo document is hierarchically organized (@pxref{makeinfo
-Pointer Creation}).
+Requirements}).  The subsequent arguments are optional---the names of
+the `Next', `Previous', and `Up' pointers, in that order.  We
+recommend omitting them if your Texinfo document is hierarchically
+organized, as virtually all are (@pxref{makeinfo Pointer Creation}).
+You may insert spaces before or after each name on the @code{@@node}
+line if you wish; the spaces are ignored.
 @opindex address@hidden, in HTML output of nodes}
 Whether the node pointers are specified implicitly or explicitly, the
@@ -5080,24 +5082,23 @@
 follow the navigation using (typically) @address@hidden, e.g.,
 @kbd{M-n} for the `Next' node, from anywhere within the node.
-You may insert spaces before each name on the @code{@@node} line if
-you wish; the spaces are ignored.  You must write the name of the node
-and (if present) the names of the `Next', `Previous', and `Up'
-pointers all on the same line.  Otherwise, the formatters fail.
-(@xref{Top,, Getting Started, info, Info}, for more information about
-nodes in Info.)
 Usually, you write one of the chapter-structuring command lines
 immediately after an @code{@@node} line---for example, an
 @code{@@section} or @code{@@subsection} line.  (@xref{Structuring
 Command Types}.)
address@hidden uses @code{@@node} lines to identify the names to use for cross
-references.  For this reason, you must write @code{@@node} lines in a
-Texinfo file that you intend to format for printing, even if you do not
-intend to format it for Info.  (Cross references, such as the one at the
-end of this sentence, are made with @code{@@xref} and related commands;
-see @ref{Cross References}.)
address@hidden uses both @code{@@node} names and chapter-structuring names in
+the output for cross references.  For this reason, you must write
address@hidden@@node} lines in a Texinfo file that you intend to format for
+printing, even if you do not intend to format it for Info; and you
+must include a chapter-structuring command after a node for it to be a
+valid cross-reference target (to @TeX{}).  You can use @code{@@anchor}
+(@pxref{anchor,, @code{@@anchor}}) to make cross references to an
+arbitrary position in a document.
+Cross references, such as the one at the end of this sentence, are
+made with @code{@@xref} and related commands; see @ref{Cross
 * Node Names::                  How to choose node and pointer names.
@@ -6096,7 +6097,7 @@
 @node One Argument
 @subsection @code{@@xref} with One Argument
address@hidden One-argument form of cross-references
address@hidden One-argument form of cross references
 The simplest form of @code{@@xref} takes one argument, the name of
 another node in the same Info file.  The Info formatters produce
@@ -6156,7 +6157,7 @@
 @node Two Arguments
 @subsection @code{@@xref} with Two Arguments
address@hidden Two-argument form of cross-references
address@hidden Two-argument form of cross references
 With two arguments, the second is used as the name of the Info cross
 reference, while the first is still the name of the node to which the
@@ -6223,7 +6224,7 @@
 @node Three Arguments
 @subsection @code{@@xref} with Three Arguments
address@hidden Three-argument form of cross-references
address@hidden Three-argument form of cross references
 A third argument replaces the node name in the @TeX{} output.  The third
 argument should be the name of the section in the printed output, or
@@ -6323,7 +6324,7 @@
 @node Four and Five Arguments
 @subsection @code{@@xref} with Four and Five Arguments
address@hidden Four- and five argument form of cross-references
address@hidden Four- and five argument forms of cross references
 In a cross reference, a fourth argument specifies the name of another
 Info file, different from the file in which the reference appears, and
@@ -6664,7 +6665,7 @@
 This works fine.  @code{@@pxref} should only be followed by a comma,
 period, or right parenthesis; in other cases, @command{makeinfo} has
-to insert a period to make the cross-reference work correctly in Info,
+to insert a period to make the cross reference work correctly in Info,
 and that period looks wrong.
 As a matter of general style, @code{@@pxref} is best used at the ends
@@ -10857,7 +10858,7 @@
 Therefore Texinfo provides the @code{@@frenchspacing} command to
 control the spacing after punctuation.  It reads the rest of the line
 as its argument, which must be the single word @samp{on} or @samp{off}
-(always these words, regardless of the language) of the document.
+(always these words, regardless of the language of the document).
 Here is an example:
@@ -17362,7 +17363,7 @@
 For address@hidden  Base directory for external manuals.  It is better to use
-the general external cross-reference mechanism (@pxref{HTML Xref
+the general external cross reference mechanism (@pxref{HTML Xref
 Configuration}) and avoid this variable.
@@ -17716,25 +17717,28 @@
-Default for Info, not for other output.  If, set use what
+Default is on for Info, off for other output.  If set, use what
 @code{@@setfilename} gives for the output file name, including the
-extension.  You should not need to set this variable.
+extension.  You should not need to explicitly set this variable.
 Use the full @code{@@titlepage} as the title, not a simple title string.
address@hidden when colons are supported ... pindex Text::Unidecode
address@hidden Text::Unidecode
 If set to false, do not use the @code{Text::Unidecode} Perl module to 
 transliterate more characters.
-For address@hidden  If set, a vertical navigation panel is used.
+For address@hidden  If set to true, a vertical navigation panel is used.
address@hidden Navigation panel, bottom of page
 For HTML, with output split at nodes.  Specifies the approximate
-minimum page length required before a navigation panel is placed at
-the bottom of a page.
+minimum page length at which a navigation panel is placed at the
+bottom of a page.  To avoid ever having the navigation buttons at the
+bottom of a page, set this to a sufficiently large number.  The
+default is 300.
 @end vtable
@@ -21796,7 +21800,7 @@
 Revision Control System}) or other version control systems, which
 expand it into a string such as:
-$Id: texinfo.txi,v 1.429 2012/02/26 22:01:47 pertusus Exp $
+$Id: texinfo.txi,v 1.430 2012/04/08 17:02:23 karl Exp $
 @end example
 (This is useful in all sources that use version control, not just manuals.)
 You may wish to include the @samp{$Id:} comment in the @code{@@copying}

reply via email to

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