projects / OpenSPARC-T2-SAM / blame
| Commit | Line | Data |
|---|---|---|
| 920dae64 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="special-constructs.html" /> | |
| 12 | <link rel="prev" href="latex-primer.html" /> | |
| 13 | <link rel="parent" href="doc.html" /> | |
| 14 | <link rel="next" href="special-constructs.html" /> | |
| 15 | <meta name='aesop' content='information' /> | |
| 16 | <title>5 Document Classes </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.3 Common Environments" | |
| 24 | href="latex-environments.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="Documenting Python" | |
| 27 | href="doc.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 Special Markup Constructs" | |
| 30 | href="special-constructs.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-environments.html">4.3 Common Environments</A> | |
| 44 | <b class="navlabel">Up:</b> | |
| 45 | <a class="sectref" rel="parent" href="doc.html">Documenting Python</A> | |
| 46 | <b class="navlabel">Next:</b> | |
| 47 | <a class="sectref" rel="next" href="special-constructs.html">6 Special Markup Constructs</A> | |
| 48 | </div> | |
| 49 | <hr /></div> | |
| 50 | </DIV> | |
| 51 | <!--End of Navigation Panel--> | |
| 52 | ||
| 53 | <H1><A NAME="SECTION000600000000000000000"></A><A NAME="classes"></A> | |
| 54 | <BR> | |
| 55 | 5 Document Classes | |
| 56 | </H1> | |
| 57 | ||
| 58 | <P> | |
| 59 | Two <span class="LaTeX">LaTeX</span> document classes are defined specifically for use with | |
| 60 | the Python documentation. The <code>manual</code> class is for large | |
| 61 | documents which are sectioned into chapters, and the <code>howto</code> | |
| 62 | class is for smaller documents. | |
| 63 | ||
| 64 | <P> | |
| 65 | The <code>manual</code> documents are larger and are used for most of the | |
| 66 | standard documents. This document class is based on the standard | |
| 67 | <span class="LaTeX">LaTeX</span> <code>report</code> class and is formatted very much like a long | |
| 68 | technical report. The <em class="citetitle"><a | |
| 69 | href="../ref/ref.html" | |
| 70 | title="Python Reference | |
| 71 | Manual" | |
| 72 | >Python Reference | |
| 73 | Manual</a></em> is a good example of a <code>manual</code> document, and the | |
| 74 | <em class="citetitle"><a | |
| 75 | href="../lib/lib.html" | |
| 76 | title="Python Library Reference" | |
| 77 | >Python Library Reference</a></em> is a large | |
| 78 | example. | |
| 79 | ||
| 80 | <P> | |
| 81 | The <code>howto</code> documents are shorter, and don't have the large | |
| 82 | structure of the <code>manual</code> documents. This class is based on | |
| 83 | the standard <span class="LaTeX">LaTeX</span> <code>article</code> class and is formatted somewhat | |
| 84 | like the Linux Documentation Project's ``HOWTO'' series as done | |
| 85 | originally using the LinuxDoc software. The original intent for the | |
| 86 | document class was that it serve a similar role as the LDP's HOWTO | |
| 87 | series, but the applicability of the class turns out to be somewhat | |
| 88 | broader. This class is used for ``how-to'' documents (this | |
| 89 | document is an example) and for shorter reference manuals for small, | |
| 90 | fairly cohesive module libraries. Examples of the later use include | |
| 91 | <em class="citetitle"><a | |
| 92 | href="http://starship.python.net/crew/fdrake/manuals/krb5py/krb5py.html" | |
| 93 | title="Using | |
| 94 | Kerberos from Python" | |
| 95 | >Using | |
| 96 | Kerberos from Python</a></em>, which contains reference material for an | |
| 97 | extension package. These documents are roughly equivalent to a | |
| 98 | single chapter from a larger work. | |
| 99 | ||
| 100 | <P> | |
| 101 | ||
| 102 | <DIV CLASS="navigation"> | |
| 103 | <div class='online-navigation'> | |
| 104 | <p></p><hr /> | |
| 105 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
| 106 | <tr> | |
| 107 | <td class='online-navigation'><a rel="prev" title="4.3 Common Environments" | |
| 108 | href="latex-environments.html"><img src='../icons/previous.png' | |
| 109 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
| 110 | <td class='online-navigation'><a rel="parent" title="Documenting Python" | |
| 111 | href="doc.html"><img src='../icons/up.png' | |
| 112 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
| 113 | <td class='online-navigation'><a rel="next" title="6 Special Markup Constructs" | |
| 114 | href="special-constructs.html"><img src='../icons/next.png' | |
| 115 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
| 116 | <td align="center" width="100%">Documenting Python</td> | |
| 117 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
| 118 | href="contents.html"><img src='../icons/contents.png' | |
| 119 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
| 120 | <td class='online-navigation'><img src='../icons/blank.png' | |
| 121 | border='0' height='32' alt='' width='32' /></td> | |
| 122 | <td class='online-navigation'><img src='../icons/blank.png' | |
| 123 | border='0' height='32' alt='' width='32' /></td> | |
| 124 | </tr></table> | |
| 125 | <div class='online-navigation'> | |
| 126 | <b class="navlabel">Previous:</b> | |
| 127 | <a class="sectref" rel="prev" href="latex-environments.html">4.3 Common Environments</A> | |
| 128 | <b class="navlabel">Up:</b> | |
| 129 | <a class="sectref" rel="parent" href="doc.html">Documenting Python</A> | |
| 130 | <b class="navlabel">Next:</b> | |
| 131 | <a class="sectref" rel="next" href="special-constructs.html">6 Special Markup Constructs</A> | |
| 132 | </div> | |
| 133 | </div> | |
| 134 | <hr /> | |
| 135 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
| 136 | </DIV> | |
| 137 | <!--End of Navigation Panel--> | |
| 138 | <ADDRESS> | |
| 139 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
| 140 | </ADDRESS> | |
| 141 | </BODY> | |
| 142 | </HTML> |