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