texinfo-commits
[Top][All Lists]
Advanced

[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: Sat, 24 Nov 2012 00:45:20 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     karl <karl>     12/11/24 00:45:19

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        example for implicit ptrs

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1454&r2=1.1455
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.492&r2=1.493

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1454
retrieving revision 1.1455
diff -u -b -r1.1454 -r1.1455
--- ChangeLog   23 Nov 2012 23:10:41 -0000      1.1454
+++ ChangeLog   24 Nov 2012 00:45:18 -0000      1.1455
@@ -2,6 +2,10 @@
 
        * pretest 4.13.91.
 
+       * doc/texinfo.txi (makeinfo Pointer Creation): be more
+       explicit about what to do.  Suggestion from Richard Jackson,
+       help-texinfo 18 Feb 2003 23:54:07.
+
 2012-11-22  Patrice Dumas  <address@hidden>
 
        * */*.pl */Makefile.am: use #! /usr/bin/env perl for shebangs in case

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.492
retrieving revision 1.493
diff -u -b -r1.492 -r1.493
--- doc/texinfo.txi     23 Nov 2012 23:10:42 -0000      1.492
+++ doc/texinfo.txi     24 Nov 2012 00:45:19 -0000      1.493
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.492 2012/11/23 23:10:42 karl Exp $
address@hidden $Id: texinfo.txi,v 1.493 2012/11/24 00:45:19 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.
 
@@ -5249,24 +5249,38 @@
 @cindex Creating pointers with @code{makeinfo}
 @cindex Pointer creation with @code{makeinfo}
 @cindex Automatic pointer creation with @code{makeinfo}
address@hidden Implicit pointer creation with @code{makeinfo}
 
-The @code{makeinfo} program has a feature for automatically
-determining node pointers for a hierarchically organized document.  We
-highly recommend using it.
-
-When you take advantage of this feature, you do not need to write the
-`Next', `Previous', and `Up' pointers after the name of a node.
-However, you must write a sectioning command, such as @code{@@chapter}
+The @code{makeinfo} program can automatically determine node pointers
+for a hierarchically organized document.  This implicit node pointer
+creation feature in @code{makeinfo} relieves you from the need to
+update menus and pointers manually or with Texinfo mode commands.
+(@xref{Updating Nodes and Menus}.)  We highly recommend taking
+advantage of this.
+
+To do so, write your @code{@@node} lines with just the name of the
+node:
+
address@hidden
+@@node My Node
address@hidden example
+
address@hidden
+You do not need to write out the `Next', `Previous', and `Up'
+pointers.
+
+Then, you must write a sectioning command, such as @code{@@chapter}
 or @code{@@section}, on the line immediately following each truncated
address@hidden@@node} line (except that comment lines may intervene).
address@hidden@@node} line (except that comment lines may intervene).  This is
+where it normally goes.
 
-In addition, you must follow the `Top' @code{@@node} line with a line
-beginning with @code{@@top} to mark the top-level node in the
-file.  @xref{top command,, The @code{@@top} Sectioning Command}.
-
-Finally, you must write the name of each node (except for the `Top'
-node) in a menu that is one or more hierarchical levels above the
-node's hierarchical level.
+Also, you must write the name of each node (except for the `Top' node)
+in a menu that is one or more hierarchical levels above the node's
+level.
+
+Finally, you must follow the `Top' @code{@@node} line with a line
+beginning with @code{@@top} to mark the top-level node in the file.
address@hidden command,, The @code{@@top} Sectioning Command}.
 
 @cindex Detail menu
 @findex detailmenu
@@ -5275,15 +5289,12 @@
 detailmenu} environment, or @command{makeinfo} will get confused,
 typically about the last and/or first node in the document.
 
-This implicit node pointer creation feature in @code{makeinfo}
-relieves you from the need to update menus and pointers manually or
-with Texinfo mode commands.  (@xref{Updating Nodes and Menus}.)
-
 In most cases, you will want to take advantage of this feature and not
-redundantly specify node pointers.  However, Texinfo documents are not
-required to be organized hierarchically or in fact to contain
-sectioning commands at all (for example, if you never intend the
-document to be printed).  
+redundantly specify node pointers that the programs can determine.
+However, Texinfo documents are not required to be organized
+hierarchically or in fact to contain sectioning commands at all (for
+example, if you never intend the document to be printed), so node
+pointers may still be specified explicitly, in full generality.
 
 
 @node anchor
@@ -21652,7 +21663,7 @@
 or other version control systems, which expand it into a string such
 as:
 @example
-$Id: texinfo.txi,v 1.492 2012/11/23 23:10:42 karl Exp $
+$Id: texinfo.txi,v 1.493 2012/11/24 00:45:19 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]