texinfo: @listoffloats

Floats

@caption @shortcaption

Back to Software Index

12.1.3 '@listoffloats': Tables of Contents for Floats
-----------------------------------------------------

You can write an '@listoffloats' command to generate a list of floats
for a given float type (Note: @float), analogous to the document's
overall table of contents.  Typically, it is written in its own
'@unnumbered' node to provide a heading and structure, rather like
'@printindex' (Note: Printing Indices & Menus).

  '@listoffloats' takes one optional argument, the float type.  Here's
an example:

     @node List of Figures
     @unnumbered List of Figures
     @listoffloats Figure

And the output from '@listoffloats':

Figure 12.1

fig:ex1.

  Without any argument, '@listoffloats' generates a list of floats for
which no float type was specified, i.e., no first argument to the
'@float' command (Note: @float).

  Each line in the list of floats contains the float type (if any), the
float number, and the caption, if any--the '@shortcaption' argument, if
it was specified, else the '@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.