blob: e2e3defb521280c52a88dca27c5387183f6c996f [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>@exampleindent (GNU Texinfo 6.8dev)</title>
<meta name="description" content="@exampleindent (GNU Texinfo 6.8dev)">
<meta name="keywords" content="@exampleindent (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="Global-Document-Commands.html" rel="up" title="Global Document Commands">
<link href="_0040smallbook.html" rel="next" title="@smallbook">
<link href="_0040firstparagraphindent.html" rel="prev" title="@firstparagraphindent">
<style type="text/css">
<!--
div.example {margin-left: 3.2em}
-->
</style>
</head>
<body lang="en">
<div class="section-level-extent" id="g_t_0040exampleindent">
<div class="nav-panel">
<p>
Next: <a href="_0040smallbook.html" accesskey="n" rel="next"><code class="code">@smallbook</code>: Printing &ldquo;Small&rdquo; Books</a>, Previous: <a href="_0040firstparagraphindent.html" accesskey="p" rel="prev"><code class="code">@firstparagraphindent</code>: Indenting After Headings</a>, Up: <a href="Global-Document-Commands.html" accesskey="u" rel="up">Global Document Commands</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>
<h3 class="section" id="g_t_0040exampleindent_003a-Environment-Indenting">E.5 <code class="code">@exampleindent</code>: Environment Indenting</h3>
<a class="anchor" id="exampleindent"></a><a class="index-entry-id" id="index-exampleindent"></a>
<a class="index-entry-id" id="index-Indenting-environments"></a>
<a class="index-entry-id" id="index-Environment-indentation"></a>
<a class="index-entry-id" id="index-Example-indentation"></a>
<p>The Texinfo processors indent each line of <code class="code">@example</code> and similar
environments. You can use the <code class="code">@exampleindent</code> command to specify
this indentation. Write an <code class="code">@exampleindent</code> command at the
beginning of a line followed by either &lsquo;<samp class="samp">asis</samp>&rsquo; or a number:
</p>
<div class="example">
<pre class="example-preformatted">@exampleindent <var class="var">indent</var>
</pre></div>
<p>The indentation is according to the value of <var class="var">indent</var>:
</p>
<dl class="table">
<dt><code class="code">asis</code></dt>
<dd><p>Do not change the existing indentation (not implemented in TeX).
</p>
</dd>
<dt>0</dt>
<dd><p>Omit all indentation.
</p>
</dd>
<dt><var class="var">n</var></dt>
<dd><p>Indent environments by <var class="var">n</var> space characters in Info output, by
<var class="var">n</var> ems in TeX.
</p>
</dd>
</dl>
<p>The default value of <var class="var">indent</var> is 5 spaces in Info, and 0.4<span class="dmn">in</span>
in TeX, which is somewhat less. (The reduction is to help TeX
fit more characters onto physical lines.)
</p>
<p>It is best to write the <code class="code">@exampleindent</code> command before the
end-of-header line at the beginning of a Texinfo file, so the region
formatting commands indent paragraphs as specified. See <a class="xref" href="Start-of-Header.html">Start of Header</a>.
</p>
</div>
</body>
</html>