blob: 6d1561391f235e020d029b18de83b305fa6ba3a0 [file]
<!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>Info Format Image (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Info Format Image (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Info Format Image (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="Info-Format-Text-Constructs.html" rel="up" title="Info Format Text Constructs">
<link href="Info-Format-Printindex.html" rel="next" title="Info Format Printindex">
<link href="Info-Format-Menu.html" rel="prev" title="Info Format Menu">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="subsection-level-extent" id="Info-Format-Image">
<div class="nav-panel">
<p>
Next: <a href="Info-Format-Printindex.html" accesskey="n" rel="next">Info Format: Printindex</a>, Previous: <a href="Info-Format-Menu.html" accesskey="p" rel="prev">Info Format: Menu</a>, Up: <a href="Info-Format-Text-Constructs.html" accesskey="u" rel="up">Info Format Text Constructs</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="Info-Format_003a-Image">F.2.2 Info Format: Image</h4>
<a class="index-entry-id" id="index-Images-3"></a>
<p>The <code class="code">@image</code> command results in the following special directive
within the Info file (see <a class="pxref" href="Images.html">Inserting Images</a>):
</p>
<div class="example">
<pre class="example-preformatted"> &lt;image&gt; =
^@^H[image src=&quot;&lt;image file&gt;&quot;
(text=&quot;&lt;txt file contents&gt;&quot;)?
(alt=&quot;&lt;alt text&gt;&quot;)?
^@^H]
</pre></div>
<p>The line breaks and indentation in this description are editorial; the
whitespace between the different parts of the directive in Info files
is arbitrary.
</p>
<p>In the strings <code class="t">&lt;image file&gt;</code>, <code class="t">&lt;txt file contents&gt;</code> and <code class="t">&lt;alt
text&gt;</code>, &lsquo;<samp class="samp">&quot;</samp>&rsquo; is quoted as &lsquo;<samp class="samp">\&quot;</samp>&rsquo; and &lsquo;<samp class="samp">\</samp>&rsquo; is quoted as
&lsquo;<samp class="samp">\\</samp>&rsquo;. The txt and alt specifications are optional.
</p>
<p>The <code class="t">alt</code> value serves the same purpose as in HTML: A prose
description of the image. In text-only displays or speech systems,
for example, the <code class="t">alt</code> value may be used instead of displaying the
(typically graphical) <code class="t">&lt;image file&gt;</code>.
</p>
<p>The <code class="t">&lt;txt file contents&gt;</code>, if present, should be taken as an ASCII
representation of the image, for possible use on a text-only display.
</p>
<p>The format does not prescribe the choice between displaying the
<code class="t">&lt;image file&gt;</code>, the <code class="t">&lt;alt text&gt;</code> or the <code class="t">&lt;txt file contents&gt;</code>.
</p>
</div>
</body>
</html>