texinfo/doc texinfo.txi,1.22,1.23

[karl]

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

Modified Files:
        texinfo.txi 
Log Message:
(float): continue documenting.

Index: texinfo.txi
===================================================================
RCS file: /cvsroot/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -d -r1.22 -r1.23
*** texinfo.txi 6 Feb 2004 01:29:02 -0000       1.22
--- texinfo.txi 12 Feb 2004 00:30:23 -0000      1.23
***************
*** 8889,8901 ****
  some similar type.
  
! A float is so-named because, in principle, it can be moved in the
! printed output, to the bottom, top, or a following page.  (Floating
! does not make sense in other output formats.)  In the present version
! of Texinfo, however, this floating is unfortunately not yet
! implemented.
  
  @menu
  * float::                       Producing floating material.
! * caption shortcaption::        Giving floats descriptions.
  * listoffloats::                A table of contents for floats.
  @end menu
--- 8889,8904 ----
  some similar type.
  
! @cindex Floating, not yet implemented
! A float is so-named because, in principle, it can be moved to the
! bottom or top of the current page, or to a following page, in the
! printed output.  (Floating does not make sense in other output
! formats.)  In the present version of Texinfo, however, this floating
! is unfortunately not yet implemented.  Instead, the floating material
! is simply output at the current location, more or less as if it were
! an @code{@@group} (@pxref{group,,@code{@@group}}).
  
  @menu
  * float::                       Producing floating material.
! * caption shortcaption::        Specifying descriptions for floats.
  * listoffloats::                A table of contents for floats.
  @end menu
***************
*** 8903,8907 ****
  
  @node float
! @subsection @code{@@float} address@hidden,@var{label}]]: Floating material
  @findex float
  @cindex Float environment
--- 8906,8910 ----
  
  @node float
! @subsection @code{@@float} address@hidden,@var{label}]: Floating material
  @findex float
  @cindex Float environment
***************
*** 8909,8925 ****
  To produce floating material, enclose the material you want to be
  displayed separate between @code{@@float} and @code{@@end float}
! commands, on lines by themselves.
  
! @code{@@float} takes two optional arguments (separated by a comma),
! @var{type} and @var{label}.
  
  @table @var
  @item type
! Specifies the sort of float this is; typically ``Figure'', ``Table'', etc.
! If not given, 
  @item label
! Specifies a cross-reference label for this float.
  @end table
  
  
  
--- 8912,8964 ----
  To produce floating material, enclose the material you want to be
  displayed separate between @code{@@float} and @code{@@end float}
! commands, on lines by themselves.  Here's an example:
  
! @example
! @@float Figure,fig:ex1
! This is an example float.
! @@end float
! @end example
! 
! @noindent And the output:
! @float Figure,fig:ex1
! This is an example float.
! @end float
! 
! As shown in the example, @code{@@float} takes two arguments (separated
! by a comma), @var{type} and @var{label}.  Both are optional.
  
  @table @var
  @item type
! Specifies the sort of float this is; typically a word such as
! ``Figure'', ``Table'', etc.  If not given, and @var{label} is, any
! cross-referencing will simply use a bare number.
! 
  @item label
! Specifies a cross-reference label for this float.  If given, this
! float is automatically given a number, and will appear in any
! @code{@@listofloats} output (@pxref{listoffloats}).  Cross-references
! to @var{label} are allowed.
! 
! @cindex Floats, making unnumbered
! @cindex Unnumbered float, creating
! On the other hand, if @var{label} is not given, then the float will
! not be numbered and consequently will not appear in the
! @code{@@listoffloats} output or be cross-referenceable.
  @end table
  
+ @noindent Normally, you specify both @var{type} and @var{label}, to get a
+ labeled and numbered float.
+ 
+ @cindex Floats, numbering of
+ @cindex Numbering of floats
+ In Texinfo, all floats are numbered the same way: with the chapter
+ number (or appendix letter), a period, and the float number, which
+ simply counts 1, 2, 3, @dots{}, and is reset at each chapter.  Each
+ float type is counted independently.  
+ 
+ Floats within an @code{@@unnumbered} are numbered, or outside of any
+ chapter, are simply numbered consecutively from 1.
+ 
+ These numbering conventions are not, at present, changeable.
  
  
***************
*** 8940,8944 ****
  
  You can insert an image given in an external file with the
! @code{@@image} command.
  
  @menu
--- 8979,8985 ----
  
  You can insert an image given in an external file with the
! @code{@@image} command.  Although images can be used anywhere,
! including the middle of a paragraph, we describe them in this chapter
! since they are most often part of a displayed figure or example.
  
  @menu