<!DOCTYPE html PUBLIC
"-//W3C//DTD HTML 4.0 Transitional//EN">
<link rel=
"STYLESHEET" href=
"doc.css" type='text/css'
/>
<link rel=
"SHORTCUT ICON" href=
"../icons/pyfav.png" type=
"image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index'
/>
<link rel=
"first" href=
"doc.html" title='Documenting Python'
/>
<link rel='contents' href='contents.html'
title=
"Contents" />
<link rel='last' href='about.html' title='About this document...'
/>
<link rel='help' href='about.html' title='About this document...'
/>
<link rel=
"next" href=
"special-constructs.html" />
<link rel=
"prev" href=
"latex-primer.html" />
<link rel=
"parent" href=
"doc.html" />
<link rel=
"next" href=
"special-constructs.html" />
<meta name='aesop' content='information'
/>
<title>5 Document Classes
</title>
<div id='top-navigation-panel' xml:id='top-navigation-panel'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"4.3 Common Environments"
href=
"latex-environments.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"Documenting Python"
href=
"doc.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"6 Special Markup Constructs"
href=
"special-constructs.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Documenting Python
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"latex-environments.html">4.3 Common Environments
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"doc.html">Documenting Python
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"special-constructs.html">6 Special Markup Constructs
</A>
<!--End of Navigation Panel-->
<H1><A NAME=
"SECTION000600000000000000000"></A><A NAME=
"classes"></A>
Two
<span class=
"LaTeX">LaTeX
</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.
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=
"LaTeX">LaTeX
</span> <code>report
</code> class and is formatted very much like a long
technical report. The
<em class=
"citetitle"><a
Manual
</a></em> is a good example of a
<code>manual
</code> document, and the
title=
"Python Library Reference"
>Python Library Reference
</a></em> is a large
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=
"LaTeX">LaTeX
</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
href=
"http://starship.python.net/crew/fdrake/manuals/krb5py/krb5py.html"
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.
<div class='online-navigation'
>
<table align=
"center" width=
"100%" cellpadding=
"0" cellspacing=
"2">
<td class='online-navigation'
><a rel=
"prev" title=
"4.3 Common Environments"
href=
"latex-environments.html"><img src='../icons/previous.png'
border='
0' height='
32' alt='Previous Page' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"parent" title=
"Documenting Python"
href=
"doc.html"><img src='../icons/up.png'
border='
0' height='
32' alt='Up One Level' width='
32'
/></A></td>
<td class='online-navigation'
><a rel=
"next" title=
"6 Special Markup Constructs"
href=
"special-constructs.html"><img src='../icons/next.png'
border='
0' height='
32' alt='Next Page' width='
32'
/></A></td>
<td align=
"center" width=
"100%">Documenting Python
</td>
<td class='online-navigation'
><a rel=
"contents" title=
"Table of Contents"
href=
"contents.html"><img src='../icons/contents.png'
border='
0' height='
32' alt='Contents' width='
32'
/></A></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<td class='online-navigation'
><img src='../icons/blank.png'
border='
0' height='
32' alt='' width='
32'
/></td>
<div class='online-navigation'
>
<b class=
"navlabel">Previous:
</b>
<a class=
"sectref" rel=
"prev" href=
"latex-environments.html">4.3 Common Environments
</A>
<b class=
"navlabel">Up:
</b>
<a class=
"sectref" rel=
"parent" href=
"doc.html">Documenting Python
</A>
<b class=
"navlabel">Next:
</b>
<a class=
"sectref" rel=
"next" href=
"special-constructs.html">6 Special Markup Constructs
</A>
<span class=
"release-info">Release
2.4.2, documentation updated on
28 September
2005.
</span>
<!--End of Navigation Panel-->
See
<i><a href=
"about.html">About this document...
</a></i> for information on suggesting changes.