infog/test-infodir/texinfo_html/_0040float.html - texinfo - Git at Google

 <!DOCTYPE html>
 <html>
 <!-- Created by Texinfo 6.8dev+dev, http://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.8dev, 23 February 2022),
 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-2022 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.8dev)</title>

 <meta name="description" content="@float (GNU Texinfo 6.8dev)">
 <meta name="keywords" content="@float (GNU Texinfo 6.8dev)">
 <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">
 <!--
 div.example {margin-left: 3.2em}
 -->
 </style>


 </head>

 <body lang="en">
 <div class="subsection-level-extent" id="g_t_0040float">
 <div class="nav-panel">
 <p>
 Next: <a href="_0040caption-_0040shortcaption.html" accesskey="n" rel="next"><code class="code">@caption</code> &amp; <code class="code">@shortcaption</code></a>, Up: <a href="Floats.html" accesskey="u" rel="up">Floats</a> &nbsp; [<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>
 <h4 class="subsection" id="g_t_0040float-_005btype_005d_005b_002clabel_005d_003a-Floating-Material">9.1.1 <code class="code">@float</code> [<var class="var">type</var>][,<var class="var">label</var>]: Floating Material</h4>

 <a class="anchor" id="float"></a><a class="index-entry-id" id="index-float"></a>
 <a class="index-entry-id" id="index-Float-environment"></a>

 <p>To produce floating material, enclose the material you want to be
 displayed separate between <code class="code">@float</code> and <code class="code">@end float</code>
 commands, on lines by themselves.
 </p>
 <p>Floating material often uses <code class="code">@image</code> to display an
 already-existing graphic (see <a class="pxref" href="Images.html">Inserting Images</a>), or <code class="code">@multitable</code> to
 display a table (see <a class="pxref" href="Multi_002dcolumn-Tables.html"><code class="code">@multitable</code>: Multi-column Tables</a>).  However, the contents
 of the float can be anything.  Here&rsquo;s an example with simple text:
 </p>
 <div class="example">
 <pre class="example-preformatted">@float Figure,fig:ex1
 This is an example float.
 @end float
 </pre></div>

 <p>And the output:
 </p>
 <div class="float" id="fig_003aex1">
 <p>This is an example float.
 </p><div class="type-number-float"><p><strong class="strong">Figure 9.1
 </strong></p></div></div>
 <p>As shown in the example, <code class="code">@float</code> takes two arguments (separated
 by a comma), <var class="var">type</var> and <var class="var">label</var>.  Both are optional.
 </p>
 <dl class="table">
 <dt><var class="var">type</var></dt>
 <dd><p>Specifies the sort of float this is; typically a word such as
 &ldquo;Figure&rdquo;, &ldquo;Table&rdquo;, etc.  If this is not given, and <var class="var">label</var> is,
 any cross-referencing will simply use a bare number.
 </p>
 </dd>
 <dt><var class="var">label</var></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 class="code">@listoffloats</code> output (see <a class="pxref" href="_0040listoffloats.html"><code class="code">@listoffloats</code>: Tables of Contents for Floats</a>).  Cross
 references to <var class="var">label</var> are allowed.  For example,
 &lsquo;<samp class="samp">see @ref{fig:ex1}</samp>&rsquo; will produce see <a class="ref" href="#fig_003aex1">Figure 9.1</a>.
 </p>

 <a class="index-entry-id" id="index-Floats-1"></a>
 <a class="index-entry-id" id="index-Unnumbered-float_002c-creating"></a>
 <p>On the other hand, if <var class="var">label</var> is not given, then the float will
 not be numbered and consequently will not appear in the
 <code class="code">@listoffloats</code> output or be cross-referenceable.
 </p></dd>
 </dl>

 <p>Ordinarily, you specify both <var class="var">type</var> and <var class="var">label</var>, to get a
 labeled and numbered float.
 </p>
 <a class="index-entry-id" id="index-Floats-2"></a>
 <a class="index-entry-id" id="index-Numbering-of-floats"></a>
 <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, &hellip;, and is reset at each chapter.  Each
 float type is counted independently.
 </p>
 <p>Floats within an <code class="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="nav-panel">
 <p>
 Next: <a href="_0040caption-_0040shortcaption.html"><code class="code">@caption</code> &amp; <code class="code">@shortcaption</code></a>, Up: <a href="Floats.html">Floats</a> &nbsp; [<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>
	<!DOCTYPE html>
	<html>
	<!-- Created by Texinfo 6.8dev+dev, http://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.8dev, 23 February 2022),
	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-2022 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.8dev)</title>

	<meta name="description" content="@float (GNU Texinfo 6.8dev)">
	<meta name="keywords" content="@float (GNU Texinfo 6.8dev)">
	<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">
	<!--
	div.example {margin-left: 3.2em}
	-->
	</style>


	</head>

	<body lang="en">
	<div class="subsection-level-extent" id="g_t_0040float">
	<div class="nav-panel">
	<p>
	Next: <a href="_0040caption-_0040shortcaption.html" accesskey="n" rel="next"><code class="code">@caption</code> & <code class="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>
	<h4 class="subsection" id="g_t_0040float-_005btype_005d_005b_002clabel_005d_003a-Floating-Material">9.1.1 <code class="code">@float</code> [<var class="var">type</var>][,<var class="var">label</var>]: Floating Material</h4>

	<a class="anchor" id="float"></a><a class="index-entry-id" id="index-float"></a>
	<a class="index-entry-id" id="index-Float-environment"></a>

	<p>To produce floating material, enclose the material you want to be
	displayed separate between <code class="code">@float</code> and <code class="code">@end float</code>
	commands, on lines by themselves.
	</p>
	<p>Floating material often uses <code class="code">@image</code> to display an
	already-existing graphic (see <a class="pxref" href="Images.html">Inserting Images</a>), or <code class="code">@multitable</code> to
	display a table (see <a class="pxref" href="Multi_002dcolumn-Tables.html"><code class="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-preformatted">@float Figure,fig:ex1
	This is an example float.
	@end float
	</pre></div>

	<p>And the output:
	</p>
	<div class="float" id="fig_003aex1">
	<p>This is an example float.
	</p><div class="type-number-float"><p><strong class="strong">Figure 9.1
	</strong></p></div></div>
	<p>As shown in the example, <code class="code">@float</code> takes two arguments (separated
	by a comma), <var class="var">type</var> and <var class="var">label</var>. Both are optional.
	</p>
	<dl class="table">
	<dt><var class="var">type</var></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 class="var">label</var> is,
	any cross-referencing will simply use a bare number.
	</p>
	</dd>
	<dt><var class="var">label</var></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 class="code">@listoffloats</code> output (see <a class="pxref" href="_0040listoffloats.html"><code class="code">@listoffloats</code>: Tables of Contents for Floats</a>). Cross
	references to <var class="var">label</var> are allowed. For example,
	‘<samp class="samp">see @ref{fig:ex1}</samp>’ will produce see <a class="ref" href="#fig_003aex1">Figure 9.1</a>.
	</p>

	<a class="index-entry-id" id="index-Floats-1"></a>
	<a class="index-entry-id" id="index-Unnumbered-float_002c-creating"></a>
	<p>On the other hand, if <var class="var">label</var> is not given, then the float will
	not be numbered and consequently will not appear in the
	<code class="code">@listoffloats</code> output or be cross-referenceable.
	</p></dd>
	</dl>

	<p>Ordinarily, you specify both <var class="var">type</var> and <var class="var">label</var>, to get a
	labeled and numbered float.
	</p>
	<a class="index-entry-id" id="index-Floats-2"></a>
	<a class="index-entry-id" id="index-Numbering-of-floats"></a>
	<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 class="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="nav-panel">
	<p>
	Next: <a href="_0040caption-_0040shortcaption.html"><code class="code">@caption</code> & <code class="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>