<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>5 Document Classes </title> <META NAME="description" CONTENT="5 Document Classes "> <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="special-constructs.html"> <LINK REL="previous" href="latex-primer.html"> <LINK REL="up" HREF="doc.html"> <LINK REL="next" href="special-constructs.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="latex-syntax.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A HREF="doc.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="special-constructs.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="latex-syntax.html">4.2 Hierarchical Structure</A> <b class="navlabel">Up:</b> <a class="sectref" HREF="doc.html">Documenting Python</A> <b class="navlabel">Next:</b> <a class="sectref" href="special-constructs.html">6 Special Markup Constructs</A> <br><hr> </DIV> <!--End of Navigation Panel--> <H1><A NAME="SECTION000600000000000000000"> </A> <BR> 5 Document Classes </H1> <P> Two <SPAN CLASS="logo,LaTeX">L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X</SPAN> document classes are defined specifically for use with the Python documentation. The <code>manual</code> class is for large documents which are sectioned into chapters, and the <code>howto</code> class is for smaller documents. <P> The <code>manual</code> documents are larger and are used for most of the standard documents. This document class is based on the standard <SPAN CLASS="logo,LaTeX">L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X</SPAN> <code>report</code> class and is formatted very much like a long technical report. The <em class="citetitle"><a href="../ref/ref.html" title="Python Reference Manual" >Python Reference Manual</a></em> is a good example of a <code>manual</code> document, and the <em class="citetitle"><a href="../lib/lib.html" title="Python Library Reference" >Python Library Reference</a></em> is a large example. <P> The <code>howto</code> documents are shorter, and don't have the large structure of the <code>manual</code> documents. This class is based on the standard <SPAN CLASS="logo,LaTeX">L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X</SPAN> <code>article</code> class and is formatted somewhat like the Linux Documentation Project's ``HOWTO'' series as done originally using the LinuxDoc software. The original intent for the document class was that it serve a similar role as the LDP's HOWTO series, but the applicability of the class turns out to be somewhat broader. This class is used for ``how-to'' documents (this document is an example) and for shorter reference manuals for small, fairly cohesive module libraries. Examples of the later use include <em class="citetitle"><a href="http://starship.python.net/crew/fdrake/manuals/krb5py/krb5py.html" title="Using Kerberos from Python" >Using Kerberos from Python</a></em>, which contains reference material for an extension package. These documents are roughly equivalent to a single chapter from a larger work. <P> <DIV CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><A href="latex-syntax.html"><img src="../icons/previous.gif" border="0" height="32" alt="Previous Page" width="32"></A></td> <td><A HREF="doc.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="special-constructs.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="latex-syntax.html">4.2 Hierarchical Structure</A> <b class="navlabel">Up:</b> <a class="sectref" HREF="doc.html">Documenting Python</A> <b class="navlabel">Next:</b> <a class="sectref" href="special-constructs.html">6 Special Markup Constructs</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>
