JezK
Edit File: _0040caption-_0040shortcaption.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>@caption @shortcaption (GNU Texinfo 6.8)</title> <meta name="description" content="@caption @shortcaption (GNU Texinfo 6.8)"> <meta name="keywords" content="@caption @shortcaption (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="_0040listoffloats.html" rel="next" title="@listoffloats"> <link href="_0040float.html" rel="prev" title="@float"> <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_0040caption-_0040shortcaption"> <div class="header"> <p> Next: <a href="_0040listoffloats.html" accesskey="n" rel="next"><code>@listoffloats</code>: Tables of Contents for Floats</a>, Previous: <a href="_0040float.html" accesskey="p" rel="prev"><code>@float</code> [<var>type</var>][,<var>label</var>]: Floating Material</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_0040caption-_0026-_0040shortcaption"></span><h4 class="subsection">9.1.2 <code>@caption</code> & <code>@shortcaption</code></h4> <span id="caption-shortcaption"></span><span id="index-caption"></span> <span id="index-shortcaption"></span> <span id="index-Captions_002c-for-floats"></span> <span id="index-Short-captions_002c-for-lists-of-floats"></span> <p>You may write a <code>@caption</code> anywhere within a <code>@float</code> environment, to define a caption for the float. It is not allowed in any other context. <code>@caption</code> takes a single argument, enclosed in braces. Here’s an example: </p> <div class="example"> <pre class="example">@float An example float, with caption. @caption{Caption for example float.} @end float </pre></div> <p>The output is: </p> <div class="float"> <p>An example float, with caption. </p> <div class="float-caption"><p>Caption for example float.</p></div></div> <p><code>@caption</code> can appear anywhere within the float; it is not processed until the <code>@end float</code>. The caption text is usually a sentence or two, but may consist of several paragraphs if necessary. </p> <p>In the output, the caption always appears below the float; this is not currently changeable. It is preceded by the float type and/or number, as specified to the <code>@float</code> command (see the previous section). </p> <p>The <code>@shortcaption</code> command likewise may be used only within <code>@float</code>, and takes a single argument in braces. The short caption text is used instead of the caption text in a list of floats (see the next section). Thus, you can write a long caption for the main document, and a short title to appear in the list of floats. For example: </p> <div class="example"> <pre class="example">@float ... as above ... @shortcaption{Text for list of floats.} @end float </pre></div> <p>The text for <code>@shortcaption</code> may not contain comments (<code>@c</code>), verbatim text (<code>@verb</code>), environments such as <code>@example</code>, footnotes (<code>@footnote</code>) or other complex constructs. The same constraints apply to <code>@caption</code> unless there is a <code>@shortcaption</code>. </p> </div> <hr> <div class="header"> <p> Next: <a href="_0040listoffloats.html"><code>@listoffloats</code>: Tables of Contents for Floats</a>, Previous: <a href="_0040float.html"><code>@float</code> [<var>type</var>][,<var>label</var>]: Floating Material</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>