docs/public/help.html

   1 <?xml version="1.0" encoding="iso-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3           "DTD/xhtml1-transitional.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6   <title>Help</title>
   7   <link rel="stylesheet" href="epydoc.css" type="text/css"></link>
   8 </head>
   9 <body bgcolor="white" text="black" link="blue" vlink="#204080"
  10       alink="#204080">
  11
  12 <!-- =========== START OF NAVBAR =========== -->
  13 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
  14   <tr valign="center">
  15     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="yumguicore-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
  16     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
  17     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
  18     <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
  19     <th class="navbar" width="100%"></th>
  20   </tr>
  21 </table>
  22 <table width="100%" cellpadding="0" cellspacing="0">
  23   <tr valign="top">
  24     <td width="100%">
  25     </td>
  26     <td><table cellpadding="0" cellspacing="0">
  27       <tr><td align="right"><font size="-2">[<a href="../private/help.html">show&nbsp;private</a>&nbsp;|&nbsp;hide&nbsp;private]</font></td></tr>
  28       <tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a>&nbsp;|&nbsp;<a href="help.html" target="_top">no&nbsp;frames</a>]</font></td></tr>
  29     </table></td>
  30 </tr></table>
  31
  32 <center><h2> API Documentation </h2></center>
  33
  34 <p> This document contains the API (Application Programming Interface)
  35 documentation for this project.  Documentation for the Python
  36 objects defined by the project is divided into separate pages for each
  37 package, module, and class.  The API documentation also includes two
  38 pages containing information about the project as a whole: a trees
  39 page, and an index page.  </p>
  40
  41 <h2> Object Documentation </h2>
  42
  43   <p>Each <b>Package Documentation</b> page contains:
  44   <ul>
  45     <li> A description of the package. </li>
  46     <li> A list of the modules and sub-packages contained by the
  47     package.  </li>
  48     <li> A summary of the classes defined by the package. </li>
  49     <li> A summary of the functions defined by the package. </li>
  50     <li> A summary of the variables defined by the package. </li>
  51     <li> A detailed description of each function defined by the
  52     package. </li>
  53     <li> A detailed description of each variable defined by the
  54     package. </li>
  55   </ul></p>
  56
  57   <p>Each <b>Module Documentation</b> page contains:
  58   <ul>
  59     <li> A description of the module. </li>
  60     <li> A summary of the classes defined by the module. </li>
  61     <li> A summary of the functions defined by the module. </li>
  62     <li> A summary of the variables defined by the module. </li>
  63     <li> A detailed description of each function defined by the
  64     module. </li>
  65     <li> A detailed description of each variable defined by the
  66     module. </li>
  67   </ul></p>
  68
  69   <p>Each <b>Class Documentation</b> page contains:
  70   <ul>
  71     <li> A class inheritance diagram. </li>
  72     <li> A list of known subclasses. </li>
  73     <li> A description of the class. </li>
  74     <li> A summary of the methods defined by the class. </li>
  75     <li> A summary of the instance variables defined by the class. </li>
  76     <li> A summary of the class (static) variables defined by the
  77     class. </li>
  78     <li> A detailed description of each method defined by the
  79     class. </li>
  80     <li> A detailed description of each instance variable defined by the
  81     class. </li>
  82     <li> A detailed description of each class (static) variable defined
  83     by the class. </li>
  84   </ul></p>
  85
  86 <h2> Project Documentation </h2>
  87
  88   <p> The <b>Trees</b> page contains the module and class hierarchies:
  89   <ul>
  90     <li> The <i>module hierarchy</i> lists every package and module, with
  91     modules grouped into packages.  At the top level, and within each
  92     package, modules and sub-packages are listed alphabetically. </li>
  93     <li> The <i>class hierarchy</i> lists every class, grouped by base
  94     class.  If a class has more than one base class, then it will be
  95     listed under each base class.  At the top level, and under each base
  96     class, classes are listed alphabetically. </li>
  97   </ul></p>
  98
  99   <p> The <b>Index</b> page contains indices of terms and
 100   identifiers:
 101   <ul>
 102     <li> The <i>term index</i> lists every term indexed by any object's
 103     documentation.  For each term, the index provides links to each
 104     place where the term is indexed. </li>
 105     <li> The <i>identifier index</i> lists the (short) name of every package,
 106     module, class, method, function, variable, and parameter.  For each
 107     identifier, the index provides a short description, and a link to
 108     its documentation. </li>
 109   </ul></p>
 110
 111 <h2> The Table of Contents </h2>
 112
 113 <p> The table of contents occupies the two frames on the left side of
 114 the window.  The upper-left frame displays the <i>project
 115 contents</i>, and the lower-left frame displays the <i>module
 116 contents</i>: </p>
 117
 118 <center>
 119 <table class="summary" border="1" cellspacing="0" cellpadding="3">
 120   <tr heigh="30%">
 121     <td align="center">
 122        <font size="-1">Project<br>Contents<hr>...</font></td>
 123     <td align="center" rowspan="2" width="70%">
 124       API<br>Documentation<br>Frame<br><br><br>
 125     </td>
 126   </tr>
 127   <tr>
 128     <td align="center">
 129       <font size="-1">Module<br>Contents<hr>&nbsp;<br>...<br>&nbsp;</font>
 130     </td>
 131   </tr>
 132 </table><br>
 133 </center>
 134
 135 <p> The <b>project contents frame</b> contains a list of all packages
 136 and modules that are defined by the project.  Clicking on an entry
 137 will display its contents in the module contents frame.  Clicking on a
 138 special entry, labeled "Everything," will display the contents of
 139 the entire project. </p>
 140
 141 <p> The <b>module contents frame</b> contains a list of every
 142 submodule, class, type, exception, function, and variable defined by a
 143 module or package.  Clicking on an entry will display its
 144 documentation in the API documentation frame.  Clicking on the name of
 145 the module, at the top of the frame, will display the documentation
 146 for the module itself. </p>
 147
 148 <p> The "<b>frames</b>" and "<b>no frames</b>" buttons below the top
 149 navigation bar can be used to control whether the table of contents is
 150 displayed or not. </p>
 151
 152 <h2> The Navigation Bar </h2>
 153
 154 <p> A navigation bar is located at the top and bottom of every page.
 155 It indicates what type of page you are currently viewing, and allows
 156 you to go to related pages.  The following table describes the labels
 157 on the navigation bar.  Note that not some labels (such as
 158 [Parent]) are not displayed on all pages. </p>
 159
 160 <table class="summary" border="1" cellspacing="0" cellpadding="3" width="100%">
 161 <tr class="summary">
 162   <th>Label</th>
 163   <th>Highlighted when...</th>
 164   <th>Links to...</th>
 165 </tr>
 166   <tr><td valign="top"><b>[Parent]</b></td>
 167       <td valign="top"><i>(never highlighted)</i></td>
 168       <td valign="top"> the parent of the current package </td></tr>
 169   <tr><td valign="top"><b>[Package]</b></td>
 170       <td valign="top">viewing a package</td>
 171       <td valign="top">the package containing the current object
 172       </td></tr>
 173   <tr><td valign="top"><b>[Module]</b></td>
 174       <td valign="top">viewing a module</td>
 175       <td valign="top">the module containing the current object
 176       </td></tr>
 177   <tr><td valign="top"><b>[Class]</b></td>
 178       <td valign="top">viewing a class </td>
 179       <td valign="top">the class containing the current object</td></tr>
 180   <tr><td valign="top"><b>[Trees]</b></td>
 181       <td valign="top">viewing the trees page</td>
 182       <td valign="top"> the trees page </td></tr>
 183   <tr><td valign="top"><b>[Index]</b></td>
 184       <td valign="top">viewing the index page</td>
 185       <td valign="top"> the index page </td></tr>
 186   <tr><td valign="top"><b>[Help]</b></td>
 187       <td valign="top">viewing the help page</td>
 188       <td valign="top"> the help page </td></tr>
 189 </table>
 190
 191 <p> The "<b>show private</b>" and "<b>hide private</b>" buttons below
 192 the top navigation bar can be used to control whether documentation
 193 for private objects is displayed.  Private objects are usually defined
 194 as objects whose (short) names begin with a single underscore, but do
 195 not end with an underscore.  For example, "<code>_x</code>",
 196 "<code>__pprint</code>", and "<code>epydoc.epytext._tokenize</code>"
 197 are private objects; but "<code>re.sub</code>",
 198 "<code>__init__</code>", and "<code>type_</code>" are not.  However,
 199 if a module defines the "<code>__all__</code>" variable, then its
 200 contents are used to decide which objects are private. </p>
 201
 202 <p> A timestamp below the bottom navigation bar indicates when each
 203 page was last updated. </p>
 204
 205 <!-- =========== START OF NAVBAR =========== -->
 206 <table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
 207   <tr valign="center">
 208     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="yumguicore-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
 209     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="trees.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
 210     <th class="navbar">&nbsp;&nbsp;&nbsp;<a class="navbar" href="indices.html">Index</a>&nbsp;&nbsp;&nbsp;</th>
 211     <th bgcolor="#70b0f0" class="navselect">&nbsp;&nbsp;&nbsp;Help&nbsp;&nbsp;&nbsp;</th>
 212     <th class="navbar" width="100%"></th>
 213   </tr>
 214 </table>
 215
 216 <table border="0" cellpadding="0" cellspacing="0" width="100%">
 217   <tr>
 218     <td align="left"><font size="-2">Generated by Epydoc 2.1 on Thu Jul 19 13:44:22 2007</font></td>
 219     <td align="right"><a href="http://epydoc.sourceforge.net"
 220                       ><font size="-2">http://epydoc.sf.net</font></a></td>
 221   </tr>
 222 </table>
 223 </body>
 224 </html>