| 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="latex-environments.html" /> |
| 12 | <link rel="prev" href="latex-syntax.html" /> |
| 13 | <link rel="parent" href="latex-primer.html" /> |
| 14 | <link rel="next" href="latex-environments.html" /> |
| 15 | <meta name='aesop' content='information' /> |
| 16 | <title>4.2 Hierarchical Structure </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="4.1 Syntax" |
| 24 | href="latex-syntax.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="4 LaTeX Primer" |
| 27 | href="latex-primer.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="4.3 Common Environments" |
| 30 | href="latex-environments.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="latex-syntax.html">4.1 Syntax</A> |
| 44 | <b class="navlabel">Up:</b> |
| 45 | <a class="sectref" rel="parent" href="latex-primer.html">4 LaTeX Primer</A> |
| 46 | <b class="navlabel">Next:</b> |
| 47 | <a class="sectref" rel="next" href="latex-environments.html">4.3 Common Environments</A> |
| 48 | </div> |
| 49 | <hr /></div> |
| 50 | </DIV> |
| 51 | <!--End of Navigation Panel--> |
| 52 | |
| 53 | <H2><A NAME="SECTION000520000000000000000"></A><A NAME="latex-structure"></A> |
| 54 | <BR> |
| 55 | 4.2 Hierarchical Structure |
| 56 | </H2> |
| 57 | |
| 58 | <P> |
| 59 | <span class="LaTeX">LaTeX</span> expects documents to be arranged in a conventional, |
| 60 | hierarchical way, with chapters, sections, sub-sections, |
| 61 | appendixes, and the like. These are marked using macros rather |
| 62 | than environments, probably because the end of a section can be |
| 63 | safely inferred when a section of equal or higher level starts. |
| 64 | |
| 65 | <P> |
| 66 | There are six ``levels'' of sectioning in the document classes |
| 67 | used for Python documentation, and the deepest two |
| 68 | levels<A NAME="tex2html1" |
| 69 | HREF="#foot193"><SUP>1</SUP></A> are not used. The levels are: |
| 70 | |
| 71 | <P> |
| 72 | <div class="center"><table class="realtable"> |
| 73 | <thead> |
| 74 | <tr> |
| 75 | <th class="center">Level</th> |
| 76 | <th class="left" >Macro Name</th> |
| 77 | <th class="center">Notes</th> |
| 78 | </tr> |
| 79 | </thead> |
| 80 | <tbody> |
| 81 | <tr><td class="center" valign="baseline">1</td> |
| 82 | <td class="left" ><tt class='macro'>\chapter</tt></td> |
| 83 | <td class="center">(1)</td></tr> |
| 84 | <tr><td class="center" valign="baseline">2</td> |
| 85 | <td class="left" ><tt class='macro'>\section</tt></td> |
| 86 | <td class="center"></td></tr> |
| 87 | <tr><td class="center" valign="baseline">3</td> |
| 88 | <td class="left" ><tt class='macro'>\subsection</tt></td> |
| 89 | <td class="center"></td></tr> |
| 90 | <tr><td class="center" valign="baseline">4</td> |
| 91 | <td class="left" ><tt class='macro'>\subsubsection</tt></td> |
| 92 | <td class="center"></td></tr> |
| 93 | <tr><td class="center" valign="baseline">5</td> |
| 94 | <td class="left" ><tt class='macro'>\paragraph</tt></td> |
| 95 | <td class="center">(2)</td></tr> |
| 96 | <tr><td class="center" valign="baseline">6</td> |
| 97 | <td class="left" ><tt class='macro'>\subparagraph</tt></td> |
| 98 | <td class="center"></td></tr></tbody> |
| 99 | </table></div> |
| 100 | |
| 101 | <P> |
| 102 | Notes: |
| 103 | |
| 104 | <P> |
| 105 | <DL> |
| 106 | <DT><STRONG>(1)</STRONG></DT> |
| 107 | <DD>Only used for the <code>manual</code> documents, as described in |
| 108 | section <A href="classes.html#classes">5</A>, ``Document Classes.'' |
| 109 | |
| 110 | </DD> |
| 111 | <DT><STRONG>(2)</STRONG></DT> |
| 112 | <DD>Not the same as a paragraph of text; nobody seems to use this. |
| 113 | |
| 114 | </DD> |
| 115 | </DL> |
| 116 | |
| 117 | <P> |
| 118 | <BR><HR><H4>Footnotes</H4> |
| 119 | <DL> |
| 120 | <DT><A NAME="foot193">... levels</A><A |
| 121 | href="latex-structure.html#tex2html1"><SUP>1</SUP></A></DT> |
| 122 | <DD>The deepest levels have the highest numbers in the |
| 123 | table. |
| 124 | |
| 125 | </DD> |
| 126 | </DL> |
| 127 | <DIV CLASS="navigation"> |
| 128 | <div class='online-navigation'> |
| 129 | <p></p><hr /> |
| 130 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 131 | <tr> |
| 132 | <td class='online-navigation'><a rel="prev" title="4.1 Syntax" |
| 133 | href="latex-syntax.html"><img src='../icons/previous.png' |
| 134 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 135 | <td class='online-navigation'><a rel="parent" title="4 LaTeX Primer" |
| 136 | href="latex-primer.html"><img src='../icons/up.png' |
| 137 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 138 | <td class='online-navigation'><a rel="next" title="4.3 Common Environments" |
| 139 | href="latex-environments.html"><img src='../icons/next.png' |
| 140 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 141 | <td align="center" width="100%">Documenting Python</td> |
| 142 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 143 | href="contents.html"><img src='../icons/contents.png' |
| 144 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 145 | <td class='online-navigation'><img src='../icons/blank.png' |
| 146 | border='0' height='32' alt='' width='32' /></td> |
| 147 | <td class='online-navigation'><img src='../icons/blank.png' |
| 148 | border='0' height='32' alt='' width='32' /></td> |
| 149 | </tr></table> |
| 150 | <div class='online-navigation'> |
| 151 | <b class="navlabel">Previous:</b> |
| 152 | <a class="sectref" rel="prev" href="latex-syntax.html">4.1 Syntax</A> |
| 153 | <b class="navlabel">Up:</b> |
| 154 | <a class="sectref" rel="parent" href="latex-primer.html">4 LaTeX Primer</A> |
| 155 | <b class="navlabel">Next:</b> |
| 156 | <a class="sectref" rel="next" href="latex-environments.html">4.3 Common Environments</A> |
| 157 | </div> |
| 158 | </div> |
| 159 | <hr /> |
| 160 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 161 | </DIV> |
| 162 | <!--End of Navigation Panel--> |
| 163 | <ADDRESS> |
| 164 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 165 | </ADDRESS> |
| 166 | </BODY> |
| 167 | </HTML> |