root/software/session2/trunk/epydoc-html/help.html

Revision 12, 9.8 kB (checked in by t, 12 years ago)

Moved VolatileSessionStore? over to MemorySessionStore? (MO)

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