<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>6.6 Miscellaneous Text Markup </title>
<META NAME="description" CONTENT="6.6 Miscellaneous Text Markup ">
<META NAME="keywords" CONTENT="doc">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<meta http-equiv="Content-Type" content="text/html; charset=">
<link rel="STYLESHEET" href="doc.css">
<link rel="first" href="doc.html">
<link rel="contents" href="contents.html" title="Contents">
<LINK REL="next" href="module-markup.html">
<LINK REL="previous" href="inline-markup.html">
<LINK REL="up" href="special-constructs.html">
<LINK REL="next" href="module-markup.html">
</head>
<body>
<DIV CLASS="navigation">
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="inline-markup.html"><img src="../icons/previous.gif"
border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="special-constructs.html"><img src="../icons/up.gif"
border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="module-markup.html"><img src="../icons/next.gif"
border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Documenting Python</td>
<td><A href="contents.html"><img src="../icons/contents.gif"
border="0" height="32"
alt="Contents" width="32"></A></td>
<td><img src="../icons/blank.gif"
border="0" height="32"
alt="" width="32"></td>
<td><img src="../icons/blank.gif"
border="0" height="32"
alt="" width="32"></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" href="inline-markup.html">6.5 Inline Markup</A>
<b class="navlabel">Up:</b> <a class="sectref" href="special-constructs.html">6 Special Markup Constructs</A>
<b class="navlabel">Next:</b> <a class="sectref" href="module-markup.html">6.7 Module-specific Markup</A>
<br><hr>
</DIV>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION000760000000000000000"> </A>
<BR>
6.6 Miscellaneous Text Markup
</H2>
<P>
In addition to the inline markup, some additional ``block'' markup
is defined to make it easier to bring attention to various bits of
text. The markup described here serves this purpose, and is
intended to be used when marking one or more paragraphs or other
block constructs (such as <tt class='environment'>\verbatim</tt> environments).
<P>
<dl class='envdesc'>
<dt><tt>\begin{<b class='environment'>notice</b>}</tt>
<tt>[</tt><var>type</var><tt>]</tt>
<br /><tt>\end{<b class='environment'>notice</b>}</tt>
<dd>
Label some paragraphs as being worthy of additional attention from
the reader. What sort of attention is warrented can be indicated
by specifying the <var>type</var> of the notice. The only values
defined for <var>type</var> are <code>note</code> and <code>warning</code>; these
are equivalent in intent to the inline markup of the same name.
If <var>type</var> is omitted, <code>note</code> is used. Additional values
may be defined in the future.
</dl>
<P>
<DIV CLASS="navigation">
<p><hr>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td><A href="inline-markup.html"><img src="../icons/previous.gif"
border="0" height="32"
alt="Previous Page" width="32"></A></td>
<td><A href="special-constructs.html"><img src="../icons/up.gif"
border="0" height="32"
alt="Up One Level" width="32"></A></td>
<td><A href="module-markup.html"><img src="../icons/next.gif"
border="0" height="32"
alt="Next Page" width="32"></A></td>
<td align="center" width="100%">Documenting Python</td>
<td><A href="contents.html"><img src="../icons/contents.gif"
border="0" height="32"
alt="Contents" width="32"></A></td>
<td><img src="../icons/blank.gif"
border="0" height="32"
alt="" width="32"></td>
<td><img src="../icons/blank.gif"
border="0" height="32"
alt="" width="32"></td>
</tr></table>
<b class="navlabel">Previous:</b> <a class="sectref" href="inline-markup.html">6.5 Inline Markup</A>
<b class="navlabel">Up:</b> <a class="sectref" href="special-constructs.html">6 Special Markup Constructs</A>
<b class="navlabel">Next:</b> <a class="sectref" href="module-markup.html">6.7 Module-specific Markup</A>
<hr>
<span class="release-info">Release 2.2, documentation updated on December 21, 2001.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>
