manpagez: man pages & more
info texinfo
Home | html | info | man
[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [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 (see section @float [type][,label]: Floating Material), 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 (see section Printing Indices and 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:

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 (see section @float [type][,label]: Floating Material).

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.

[ << ] [ < ] [ Up ] [ > ] [ >> ]         [Top] [Contents] [Index] [ ? ]

This document was generated on October 2, 2013 using texi2html 5.0.

© 2000-2021
Individual documents may contain additional copyright information.