Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / src / nas,5.n2.os.2 / lib / python / html / python / doc / misc-text-markup.html
CommitLineData
86530b38
AT
1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="doc.css" type='text/css' />
5<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
6<link rel='start' href='../index.html' title='Python Documentation Index' />
7<link rel="first" href="doc.html" title='Documenting Python' />
8<link rel='contents' href='contents.html' title="Contents" />
9<link rel='last' href='about.html' title='About this document...' />
10<link rel='help' href='about.html' title='About this document...' />
11<link rel="next" href="module-markup.html" />
12<link rel="prev" href="inline-markup.html" />
13<link rel="parent" href="special-constructs.html" />
14<link rel="next" href="module-markup.html" />
15<meta name='aesop' content='information' />
16<title>6.6 Miscellaneous Text Markup </title>
17</head>
18<body>
19<DIV CLASS="navigation">
20<div id='top-navigation-panel' xml:id='top-navigation-panel'>
21<table align="center" width="100%" cellpadding="0" cellspacing="2">
22<tr>
23<td class='online-navigation'><a rel="prev" title="6.5 Inline Markup"
24 href="inline-markup.html"><img src='../icons/previous.png'
25 border='0' height='32' alt='Previous Page' width='32' /></A></td>
26<td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs"
27 href="special-constructs.html"><img src='../icons/up.png'
28 border='0' height='32' alt='Up One Level' width='32' /></A></td>
29<td class='online-navigation'><a rel="next" title="6.7 Module-specific Markup"
30 href="module-markup.html"><img src='../icons/next.png'
31 border='0' height='32' alt='Next Page' width='32' /></A></td>
32<td align="center" width="100%">Documenting Python</td>
33<td class='online-navigation'><a rel="contents" title="Table of Contents"
34 href="contents.html"><img src='../icons/contents.png'
35 border='0' height='32' alt='Contents' width='32' /></A></td>
36<td class='online-navigation'><img src='../icons/blank.png'
37 border='0' height='32' alt='' width='32' /></td>
38<td class='online-navigation'><img src='../icons/blank.png'
39 border='0' height='32' alt='' width='32' /></td>
40</tr></table>
41<div class='online-navigation'>
42<b class="navlabel">Previous:</b>
43<a class="sectref" rel="prev" href="inline-markup.html">6.5 Inline Markup</A>
44<b class="navlabel">Up:</b>
45<a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A>
46<b class="navlabel">Next:</b>
47<a class="sectref" rel="next" href="module-markup.html">6.7 Module-specific Markup</A>
48</div>
49<hr /></div>
50</DIV>
51<!--End of Navigation Panel-->
52
53<H2><A NAME="SECTION000760000000000000000"></A><A NAME="misc-text-markup"></A>
54<BR>
556.6 Miscellaneous Text Markup
56</H2>
57
58<P>
59In addition to the inline markup, some additional ``block'' markup
60 is defined to make it easier to bring attention to various bits of
61 text. The markup described here serves this purpose, and is
62 intended to be used when marking one or more paragraphs or other
63 block constructs (such as <tt class='environment'>&#92;verbatim</tt> environments).
64
65<P>
66
67<dl class='envdesc'>
68<dt><tt>&#92;begin{<b class='environment'>notice</b>}</tt>
69 <tt>[</tt><var>type</var><tt>]</tt>
70<br /><tt>&#92;end{<b class='environment'>notice</b>}</tt></dt>
71<dd>
72 Label some paragraphs as being worthy of additional attention from
73 the reader. What sort of attention is warranted can be indicated
74 by specifying the <var>type</var> of the notice. The only values
75 defined for <var>type</var> are <code>note</code> and <code>warning</code>; these
76 are equivalent in intent to the inline markup of the same name.
77 If <var>type</var> is omitted, <code>note</code> is used. Additional values
78 may be defined in the future.
79 </dd></dl>
80
81<P>
82
83<DIV CLASS="navigation">
84<div class='online-navigation'>
85<p></p><hr />
86<table align="center" width="100%" cellpadding="0" cellspacing="2">
87<tr>
88<td class='online-navigation'><a rel="prev" title="6.5 Inline Markup"
89 href="inline-markup.html"><img src='../icons/previous.png'
90 border='0' height='32' alt='Previous Page' width='32' /></A></td>
91<td class='online-navigation'><a rel="parent" title="6 Special Markup Constructs"
92 href="special-constructs.html"><img src='../icons/up.png'
93 border='0' height='32' alt='Up One Level' width='32' /></A></td>
94<td class='online-navigation'><a rel="next" title="6.7 Module-specific Markup"
95 href="module-markup.html"><img src='../icons/next.png'
96 border='0' height='32' alt='Next Page' width='32' /></A></td>
97<td align="center" width="100%">Documenting Python</td>
98<td class='online-navigation'><a rel="contents" title="Table of Contents"
99 href="contents.html"><img src='../icons/contents.png'
100 border='0' height='32' alt='Contents' width='32' /></A></td>
101<td class='online-navigation'><img src='../icons/blank.png'
102 border='0' height='32' alt='' width='32' /></td>
103<td class='online-navigation'><img src='../icons/blank.png'
104 border='0' height='32' alt='' width='32' /></td>
105</tr></table>
106<div class='online-navigation'>
107<b class="navlabel">Previous:</b>
108<a class="sectref" rel="prev" href="inline-markup.html">6.5 Inline Markup</A>
109<b class="navlabel">Up:</b>
110<a class="sectref" rel="parent" href="special-constructs.html">6 Special Markup Constructs</A>
111<b class="navlabel">Next:</b>
112<a class="sectref" rel="next" href="module-markup.html">6.7 Module-specific Markup</A>
113</div>
114</div>
115<hr />
116<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
117</DIV>
118<!--End of Navigation Panel-->
119<ADDRESS>
120See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
121</ADDRESS>
122</BODY>
123</HTML>