JezK
Edit File: _0040float.html
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <html> <!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> <!-- This manual is for GNU Texinfo (version 6.8, 8 June 2021), a documentation system that can produce both online information and a printed manual from a single source using semantic markup. Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2021 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". --> <title>@float (GNU Texinfo 6.8)</title> <meta name="description" content="@float (GNU Texinfo 6.8)"> <meta name="keywords" content="@float (GNU Texinfo 6.8)"> <meta name="resource-type" content="document"> <meta name="distribution" content="global"> <meta name="Generator" content="texi2any"> <meta name="viewport" content="width=device-width,initial-scale=1"> <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="_0040caption-_0040shortcaption.html" rel="next" title="@caption @shortcaption"> <style type="text/css"> <!-- a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} a.summary-letter {text-decoration: none} blockquote.indentedblock {margin-right: 0em} div.display {margin-left: 3.2em} div.example {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} span:hover a.copiable-anchor {visibility: visible} ul.no-bullet {list-style: none} --> </style> </head> <body lang="en"> <div class="subsection" id="g_t_0040float"> <div class="header"> <p> Next: <a href="_0040caption-_0040shortcaption.html" accesskey="n" rel="next"><code>@caption</code> & <code>@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_0040float-_005btype_005d_005b_002clabel_005d_003a-Floating-Material"></span><h4 class="subsection">9.1.1 <code>@float</code> [<var>type</var>][,<var>label</var>]: Floating Material</h4> <span id="float"></span><span id="index-float"></span> <span id="index-Float-environment"></span> <p>To produce floating material, enclose the material you want to be displayed separate between <code>@float</code> and <code>@end float</code> commands, on lines by themselves. </p> <p>Floating material often uses <code>@image</code> to display an already-existing graphic (see <a href="Images.html">Inserting Images</a>), or <code>@multitable</code> to display a table (see <a href="Multi_002dcolumn-Tables.html"><code>@multitable</code>: Multi-column Tables</a>). However, the contents of the float can be anything. Here’s an example with simple text: </p> <div class="example"> <pre class="example">@float Figure,fig:ex1 This is an example float. @end float </pre></div> <p>And the output: </p> <div class="float"><span id="fig_003aex1"></span> <p>This is an example float. </p><div class="float-caption"><p><strong>Figure 9.1 </strong></p></div></div> <p>As shown in the example, <code>@float</code> takes two arguments (separated by a comma), <var>type</var> and <var>label</var>. Both are optional. </p> <dl compact="compact"> <dt><span><var>type</var></span></dt> <dd><p>Specifies the sort of float this is; typically a word such as “Figure”, “Table”, etc. If this is not given, and <var>label</var> is, any cross-referencing will simply use a bare number. </p> </dd> <dt><span><var>label</var></span></dt> <dd><p>Specifies a cross-reference label for this float. If given, this float is automatically given a number, and will appear in any <code>@listoffloats</code> output (see <a href="_0040listoffloats.html"><code>@listoffloats</code>: Tables of Contents for Floats</a>). Cross references to <var>label</var> are allowed. </p> <span id="index-Floats-1"></span> <span id="index-Unnumbered-float_002c-creating"></span> <p>On the other hand, if <var>label</var> is not given, then the float will not be numbered and consequently will not appear in the <code>@listoffloats</code> output or be cross-referenceable. </p></dd> </dl> <p>Ordinarily, you specify both <var>type</var> and <var>label</var>, to get a labeled and numbered float. </p> <span id="index-Floats-2"></span> <span id="index-Numbering-of-floats"></span> <p>In Texinfo, all floats are numbered in the same way: with the chapter number (or appendix letter), a period, and the float number, which simply counts 1, 2, 3, …, and is reset at each chapter. Each float type is counted independently. </p> <p>Floats within an <code>@unnumbered</code>, or outside of any chapter, are simply numbered consecutively from 1. </p> <p>These numbering conventions are not, at present, changeable. </p> </div> <hr> <div class="header"> <p> Next: <a href="_0040caption-_0040shortcaption.html"><code>@caption</code> & <code>@shortcaption</code></a>, Up: <a href="Floats.html">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> </body> </html>