blob: 75b00037223a0ff001e3356ea406d78c9c3ecd1c [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>Block Enclosing Commands (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Block Enclosing Commands (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Block Enclosing Commands (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="Quotations-and-Examples.html" rel="up" title="Quotations and Examples">
<link href="_0040quotation.html" rel="next" title="@quotation">
</head>
<body lang="en">
<div class="section-level-extent" id="Block-Enclosing-Commands">
<div class="nav-panel">
<p>
Next: <a href="_0040quotation.html" accesskey="n" rel="next"><code class="code">@quotation</code>: Block Quotations</a>, Up: <a href="Quotations-and-Examples.html" accesskey="u" rel="up">Quotations and Examples</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="Block-Enclosing-Commands-1">7.1 Block Enclosing Commands</h3>
<p>Here is a summary of commands that enclose blocks of text, also known
as <em class="dfn">environments</em>. They&rsquo;re explained further in the following
sections.
</p>
<dl class="table">
<dt><code class="code">@quotation</code></dt>
<dd><p>Indicate text that is quoted. The text is filled, indented (from both
margins), and printed in a roman font by default.
</p>
</dd>
<dt><code class="code">@indentedblock</code></dt>
<dd><p>Like <code class="code">@quotation</code>, but the text is indented only on the left.
</p>
</dd>
<dt><code class="code">@example</code></dt>
<dd><p>Illustrate code, commands, and the like. The text is printed
in a fixed-width font, and indented but not filled.
</p>
</dd>
<dt><code class="code">@lisp</code></dt>
<dd><p>Like <code class="code">@example</code>, but specifically for illustrating Lisp code. The
text is printed in a fixed-width font, and indented but not filled.
</p>
</dd>
<dt><code class="code">@verbatim</code></dt>
<dd><p>Mark a piece of text that is to be printed verbatim; no character
substitutions are made and all commands are ignored, until the next
<code class="code">@end verbatim</code>. The text is printed in a fixed-width font,
and not indented or filled. Extra spaces and blank lines are
significant, and tabs are expanded.
</p>
</dd>
<dt><code class="code">@display</code></dt>
<dd><p>Display illustrative text. The text is indented but not filled, and
no font is selected (so, by default, the font is roman).
</p>
</dd>
<dt><code class="code">@format</code></dt>
<dd><p>Like <code class="code">@display</code> (the text is not filled and no font is
selected), but the text is not indented.
</p>
</dd>
<dt><code class="code">@smallquotation</code></dt>
<dt><code class="code">@smallindentedblock</code></dt>
<dt><code class="code">@smallexample</code></dt>
<dt><code class="code">@smalllisp</code></dt>
<dt><code class="code">@smalldisplay</code></dt>
<dt><code class="code">@smallformat</code></dt>
<dd><p>These <code class="code">@small...</code> commands are just like their non-small
counterparts, except that they output text in a smaller font size,
where possible.
</p>
</dd>
<dt><code class="code">@flushleft</code></dt>
<dt><code class="code">@flushright</code></dt>
<dd><p>Text is not filled, but is set flush with the left or right margin,
respectively.
</p>
</dd>
<dt><code class="code">@raggedright</code></dt>
<dd><p>Text is filled, but only justified on the left, leaving the right
margin ragged.
</p>
</dd>
<dt><code class="code">@cartouche</code></dt>
<dd><p>Highlight text, often an example or quotation, by drawing a box with
rounded corners around it.
</p></dd>
</dl>
<p>The <code class="code">@exdent</code> command is used within the above constructs to
undo the indentation of a line.
</p>
<p>The <code class="code">@noindent</code> command may be used after one of the above
constructs (or at the beginning of any paragraph) to prevent the
following text from being indented as a new paragraph.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="_0040quotation.html"><code class="code">@quotation</code>: Block Quotations</a>, Up: <a href="Quotations-and-Examples.html">Quotations and Examples</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>