<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual is for GNU Texinfo (version 6.7, 23 September 2019),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990, 1991, 1992, 1993, 1995, 1996, 1997,
1998, 1999, 2001, 2001, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019 Free Software
Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>@listoffloats (GNU Texinfo 6.7)</title>
<meta name="description" content="@listoffloats (GNU Texinfo 6.7)">
<meta name="keywords" content="@listoffloats (GNU Texinfo 6.7)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Floats.html" rel="up" title="Floats">
<link href="Images.html" rel="next" title="Images">
<link href="_0040caption-_0040shortcaption.html" rel="prev" title="@caption @shortcaption">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en">
<span id="g_t_0040listoffloats"></span><div class="header">
<p>
Previous: <a href="_0040caption-_0040shortcaption.html" accesskey="p" rel="prev"><code>@caption @shortcaption</code></a>, Up: <a href="Floats.html" accesskey="u" rel="up">Floats</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="g_t_0040listoffloats_003a-Tables-of-Contents-for-Floats"></span><h4 class="subsection">10.1.3 <code>@listoffloats</code>: Tables of Contents for Floats</h4>
<span id="listoffloats"></span><span id="index-listoffloats"></span>
<span id="index-List-of-floats"></span>
<span id="index-Floats_002c-list-of"></span>
<span id="index-Table-of-contents_002c-for-floats"></span>
<p>You can write a <code>@listoffloats</code> command to generate a list of
floats for a given float type (see <a href="_0040float.html"><code>@float</code></a>), analogous to
the document’s overall table of contents. Typically, it is written in
its own <code>@unnumbered</code> node to provide a heading and structure,
rather like <code>@printindex</code> (see <a href="Printing-Indices-_0026-Menus.html">Printing Indices & Menus</a>).
</p>
<p><code>@listoffloats</code> takes one optional argument, the float type.
Here’s an example:
</p>
<div class="example">
<pre class="example">@node List of Figures
@unnumbered List of Figures
@listoffloats Figure
</pre></div>
<p>And here’s what the output from <code>@listoffloats</code>
looks like, given the example figure earlier in this chapter (the Info
output is formatted as a menu):
</p>
<div class="display">
<dl class="listoffloats">
<dt><a href="_0040float.html#fig_003aex1">Figure 10.1</a></dt><dd></dd>
</dl>
</div>
<p>Without any argument, <code>@listoffloats</code> generates a list of floats
for which no float type was specified, i.e., no first argument to the
<code>@float</code> command (see <a href="_0040float.html"><code>@float</code></a>).
</p>
<p>Each line in the list of floats contains the float type (if any),
the float number, and the caption, if any—the <code>@shortcaption</code>
argument, if it was specified, else the <code>@caption</code> 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.
</p>
<p>Unnumbered floats (those without cross-reference labels) are omitted
from the list of floats.
</p>
</body>
</html>