texinfo/doc texinfo.tex,1.29,1.30 texinfo.txi,1.23,1.24

[karl]

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

Modified Files:
        texinfo.tex texinfo.txi 
Log Message:
* doc/texinfo.tex (\caption): make \long.
        * doc/texinfo.txi (Nodes): mention that changing node names is bad.
        (caption shortcaption, listoffloats): write these, finishing the
        first cut at @float documentation.

Index: texinfo.tex
===================================================================
RCS file: /cvsroot/texinfo/texinfo/doc/texinfo.tex,v
retrieving revision 1.29
retrieving revision 1.30
diff -C2 -d -r1.29 -r1.30
*** texinfo.tex 12 Feb 2004 00:24:24 -0000      1.29
--- texinfo.tex 13 Feb 2004 18:12:09 -0000      1.30
***************
*** 4,8 ****
  \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
  %
! \def\texinfoversion{2004-02-11.16}
  %
  % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
--- 4,8 ----
  \expandafter\ifx\csname fmtname\endcsname\relax\input plain\fi
  %
! \def\texinfoversion{2004-02-13.09}
  %
  % Copyright (C) 1985, 1986, 1988, 1990, 1991, 1992, 1993, 1994, 1995,
***************
*** 6431,6435 ****
  % @caption, @shortcaption are easy.
  % 
! \def\caption#1{\checkenv\float \def\thiscaption{#1}}
  \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
  
--- 6431,6435 ----
  % @caption, @shortcaption are easy.
  % 
! \long\def\caption#1{\checkenv\float \def\thiscaption{#1}}
  \def\shortcaption#1{\checkenv\float \def\thisshortcaption{#1}}
  

Index: texinfo.txi
===================================================================
RCS file: /cvsroot/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -d -r1.23 -r1.24
*** texinfo.txi 12 Feb 2004 00:30:23 -0000      1.23
--- texinfo.txi 13 Feb 2004 18:12:09 -0000      1.24
***************
*** 4652,4662 ****
  
  @dfn{Nodes} are the primary segments of a Texinfo file.  They do not
! themselves impose a hierarchical or any other kind of structure on a file.
! Nodes contain @dfn{node pointers} that name other nodes, and can contain
! @dfn{menus} which are lists of nodes.  In Info, the movement commands
! can carry you to a pointed-to node or to a node listed in a menu.  Node
! pointers and menus provide structure for Info files just as chapters,
! sections, subsections, and the like, provide structure for printed
! address@hidden
  
  @menu
--- 4652,4668 ----
  
  @dfn{Nodes} are the primary segments of a Texinfo file.  They do not
! in and of themselves impose a hierarchical or any other kind of
! structure on a file.  Nodes contain @dfn{node pointers} that name
! other nodes, and can contain @dfn{menus} which are lists of nodes.  In
! Info, the movement commands can carry you to a pointed-to node or to a
! node listed in a menu.
! 
! Node pointers and menus provide structure for Info files just as
! chapters, sections, subsections, and the like, provide structure for
! printed books.
! 
! Because node names are used in cross-references, it is not desirable
! to casually change them.  Such name changes invalidate references from
! other manuals, from mail archives, and so on.
  
  @menu
***************
*** 8921,8924 ****
--- 8927,8931 ----
  
  @noindent And the output:
+ 
  @float Figure,fig:ex1
  This is an example float.
***************
*** 8965,8972 ****
  @node caption shortcaption
  @subsection @code{@@caption} & @code{@@shortcaption}
  
  
  @node listoffloats
! @subsection @code{@@listoffloats}
  
  
--- 8972,9055 ----
  @node caption shortcaption
  @subsection @code{@@caption} & @code{@@shortcaption}
+ @findex caption
+ @findex shortcaption
+ @cindex Captions, for floats
+ @cindex Short captions, for lists of floats
+ 
+ You may write an @code{@@caption} anywhere within a @code{@@float}
+ environment, to define a caption for the float.  It is not allowed in
+ any other context.  @code{@@caption} takes a single argument, enclosed
+ in braces.  Here's an example:
+ 
+ @example
+ @@float
+ An example float, with caption.
+ @@address@hidden for example address@hidden
+ @@end float
+ @end example
+ 
+ @noindent The output is:
+ 
+ @float
+ An example float, with caption.
+ @caption{Caption for example float.}
+ @end float
+ 
+ @code{@@caption} can appear anywhere within the float; it is not
+ processed until the @code{@@end float}.  The caption text is usually a
+ sentence or two, but may consist of several paragraphs if necessary.
+ 
+ In the output, the caption always appears below the float; this is not
+ currently changeable.  It is preceded by the float type and/or number,
+ as specified to the @code{@@float} command (see the previous section).
+ 
+ The @code{@@shortcaption} command likewise may be used only within
+ @code{@@float}, and takes a single argument in braces.  The short
+ caption text is used instead of the caption text in a list of floats
+ (see the next section).  Thus, you can write a long caption for the
+ main document, and a short title to appear in the list of floats.
  
  
  @node listoffloats
! @subsection @code{@@listoffloats}: Tables of contents for floats
! @findex listoffloats
! @cindex List of floats
! @cindex Floats, list of
! @cindex Table of contents, for floats
! 
! You can write a @code{@@listoffloats} command to generate a list of
! floats for a given float type (@pxref{float}), analogous to the
! document's overall table of contents.  Typically, it is written in its
! own @code{@@unnumbered} node to provide a heading and structure,
! rather like @code{@@printindex} (@pxref{Printing Indices & Menus}).
! 
! @code{@@listoffloats} takes one optional argument, the float type.
! Here's an example:
! 
! @example
! @@node List of Figures
! @@unnumbered List of Figures
! @@listoffloats Figure
! @end example
! 
! @noindent And the output from @code{@@listoffloats}:
! 
! @display
! @listoffloats Figure
! @end display
! 
! Without any argument, @code{@@listoffloats} generates a list of
! floats for which no float type was specified, i.e., no first argument
! to the @code{@@float} command (@pxref{float}).
! 
! Each line in the list of floats contains the float type (if any),
! the float number, and the caption, if any---the @code{@@shortcaption}
! argument, if it was specified, else the @code{@@caption} argument.
! In Info, the result is a menu where each float can be selected.  In
! HTML, each line is a link to the float.  In printed output, the page
! number is included.
! 
! Unnumbered floats (those without cross-reference labels) are omitted
! from the list of floats.
  
  
***************
*** 14163,14169 ****
  included in all standard GNU distributions.  The latest version is
  always available from the Texinfo source repository:
! @display
  
@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/doc/texinfo.tex?rev=HEAD}
! @end display
  
  @pindex address@hidden, installing}
--- 14246,14252 ----
  included in all standard GNU distributions.  The latest version is
  always available from the Texinfo source repository:
! @smalldisplay
  
@uref{http://savannah.gnu.org/cgi-bin/viewcvs/texinfo/texinfo/doc/texinfo.tex?rev=HEAD}
! @end smalldisplay
  
  @pindex address@hidden, installing}
***************
*** 16415,16419 ****
  
  @item @@float
! Define floating material.  Pair with @code{@@end float}.
  @xref{Floats}.
  
--- 16498,16502 ----
  
  @item @@float
! Environment to define floating material.  Pair with @code{@@end float}.
  @xref{Floats}.