texinfo/doc texinfo.txi,1.12,1.13

[karl]

Update of /cvsroot/texinfo/texinfo/doc
In directory sheep:/tmp/cvs-serv2907/doc

Modified Files:
        texinfo.txi 
Log Message:
warning if bad char after @ref

Index: texinfo.txi
===================================================================
RCS file: /cvsroot/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -d -r1.12 -r1.13
*** texinfo.txi 2003/12/21 20:50:02     1.12
--- texinfo.txi 2003/12/22 19:34:12     1.13
***************
*** 6173,6179 ****
  @noindent
  In this example, @samp{Top} is the name of the first node, and
! @samp{Overview} is the name of the first section of the address@hidden
  @node ref
- @comment  node-name,  next,  previous,  up
  @section @code{@@ref}
  @cindex Cross references using @code{@@ref}
--- 6173,6180 ----
  @noindent
  In this example, @samp{Top} is the name of the first node, and
! @samp{Overview} is the name of the first section of the manual.
! 
! 
  @node ref
  @section @code{@@ref}
  @cindex Cross references using @code{@@ref}
***************
*** 6183,6191 ****
  @code{@@ref} is nearly the same as @code{@@xref} except that it does
  not generate a `See' in the printed output, just the reference itself.
! This makes it useful as the last part of a address@hidden
  
! @need 700
! @noindent
! For example,
  
  @cindex Hurricanes
--- 6184,6190 ----
  @code{@@ref} is nearly the same as @code{@@xref} except that it does
  not generate a `See' in the printed output, just the reference itself.
! This makes it useful as the last part of a sentence.
  
! @noindent For example,
  
  @cindex Hurricanes
***************
*** 6194,6199 ****
  @end example
  
! @noindent
! produces
  
  @example
--- 6193,6197 ----
  @end example
  
! @noindent produces (in Info):
  
  @example
***************
*** 6201,6230 ****
  @end example
  
! @noindent
! and
  
  @quotation
  For more information, see Section 8.2 [Hurricanes], page 123.
  @end quotation
- 
- The @code{@@ref} command sometimes leads writers to express themselves
- in a manner that is suitable for a printed manual but looks awkward
- in the Info format.  Bear in mind that your audience will be using
- both the printed and the Info address@hidden
  
! @need 800
! @noindent
! For example,
  
  @cindex Sea surges
  @example
- @group
  Sea surges are described in @@address@hidden@}.
- @end group
  @end example
  
! @need 800
! @noindent
! produces
  
  @quotation
--- 6199,6219 ----
  @end example
  
! @noindent and (in printed output):
  
  @quotation
  For more information, see Section 8.2 [Hurricanes], page 123.
  @end quotation
  
! The @code{@@ref} command sometimes tempts writers to express
! themselves in a manner that is suitable for a printed manual but looks
! awkward in the Info format.  Bear in mind that your audience will be
! using both the printed and the Info format.  For example:
  
  @cindex Sea surges
  @example
  Sea surges are described in @@address@hidden@}.
  @end example
  
! @noindent looks ok in the printed output:
  
  @quotation
***************
*** 6232,6238 ****
  @end quotation
  
! @need 800
! @noindent
! in a printed document, and the following in Info:
  
  @example
--- 6221,6225 ----
  @end quotation
  
! @noindent but is awkward to read in Info:
  
  @example
***************
*** 6245,6252 ****
  Otherwise, Info will not find the end of the cross reference entry and
  its attempt to follow the cross reference will fail.  As a general
! rule, you should write a period or comma after every @code{@@ref}
! command.  This looks best in both the printed and the Info output.
  @end quotation
  
  @node pxref
  @comment  node-name,  next,  previous,  up
--- 6232,6241 ----
  Otherwise, Info will not find the end of the cross reference entry and
  its attempt to follow the cross reference will fail.  As a general
! rule, you should write a period, comma, or right paren after every
! @code{@@ref} command.  This looks best in both the printed and the
! Info output.  @command{makeinfo} warns about any other character.
  @end quotation
  
+ 
  @node pxref
  @comment  node-name,  next,  previous,  up
***************
*** 13967,13977 ****
  
  For more information, see:
  @itemize @bullet
! @item @ref{settitle, , @code{@@settitle}}
! @item @ref{setchapternewpage, , @code{@@setchapternewpage}}
! @item @ref{Headings, ,Page Headings}
! @item @ref{Titlepage & Copyright Page}
! @item @ref{Printing Indices & Menus}
! @item @ref{Contents}
  @end itemize
  
--- 13956,13967 ----
  
  For more information, see:
+ 
  @itemize @bullet
! @item @ref{settitle, , @code{@@settitle}}.
! @item @ref{setchapternewpage, , @code{@@setchapternewpage}}.
! @item @ref{Headings, ,Page Headings}.
! @item @ref{Titlepage & Copyright Page}.
! @item @ref{Printing Indices & Menus}.
! @item @ref{Contents}.
  @end itemize