Changes between Initial Version and Version 1 of PloneSMS/PloneSMSCommunicator/help.html


Ignore:
Timestamp:
Dec 23, 2005 2:55:38 PM (19 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • PloneSMS/PloneSMSCommunicator/help.html

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