twisted.lore.tree.html [plain text]
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>twisted.lore.tree</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="twisted.html">Package twisted</a> ::
<a href="twisted.lore.html">Package lore</a> ::
Module tree
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="twisted.lore.tree.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module twisted.lore.tree</h2>
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_getAPI"></a><span class="summary-sig"><span class="summary-sig-name">_getAPI</span>(<span class=summary-sig-arg>node</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="_replaceWithListing"></a><span class="summary-sig"><span class="summary-sig-name">_replaceWithListing</span>(<span class=summary-sig-arg>node</span>,
<span class=summary-sig-arg>val</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>class_</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addHTMLListings"></a><span class="summary-sig"><span class="summary-sig-name">addHTMLListings</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>dir</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addMtime"></a><span class="summary-sig"><span class="summary-sig-name">addMtime</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>fullpath</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addPlainListings"></a><span class="summary-sig"><span class="summary-sig-name">addPlainListings</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>dir</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="addPyListings"></a><span class="summary-sig"><span class="summary-sig-name">addPyListings</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>dir</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="compareMarkPos"></a><span class="summary-sig"><span class="summary-sig-name">compareMarkPos</span>(<span class=summary-sig-arg>a</span>,
<span class=summary-sig-arg>b</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="comparePosition"></a><span class="summary-sig"><span class="summary-sig-name">comparePosition</span>(<span class=summary-sig-arg>a</span>,
<span class=summary-sig-arg>b</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="doFile"></a><span class="summary-sig"><span class="summary-sig-name">doFile</span>(<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>linkrel</span>,
<span class=summary-sig-arg>ext</span>,
<span class=summary-sig-arg>url</span>,
<span class=summary-sig-arg>templ</span>,
<span class=summary-sig-arg>options</span>,
<span class=summary-sig-arg>outfileGenerator</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="findNodeJustBefore"></a><span class="summary-sig"><span class="summary-sig-name">findNodeJustBefore</span>(<span class=summary-sig-arg>target</span>,
<span class=summary-sig-arg>nodes</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fixAPI"></a><span class="summary-sig"><span class="summary-sig-name">fixAPI</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>url</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fixLinks"></a><span class="summary-sig"><span class="summary-sig-name">fixLinks</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>ext</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fixRelativeLinks"></a><span class="summary-sig"><span class="summary-sig-name">fixRelativeLinks</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>linkrel</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fontifyPython"></a><span class="summary-sig"><span class="summary-sig-name">fontifyPython</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="fontifyPythonNode"></a><span class="summary-sig"><span class="summary-sig-name">fontifyPythonNode</span>(<span class=summary-sig-arg>node</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="footnotes"></a><span class="summary-sig"><span class="summary-sig-name">footnotes</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="generateToC"></a><span class="summary-sig"><span class="summary-sig-name">generateToC</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="twisted.lore.tree.html#getFirstAncestorWithSectionHeader" class="summary-sig-name"><code>getFirstAncestorWithSectionHeader</code></a>(<span class=summary-sig-arg>entry</span>)</span></code>
<br />
Go up ancestors until one with at least one <h2> is found, then
return the <h2> nodes</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getHeaders"></a><span class="summary-sig"><span class="summary-sig-name">getHeaders</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getOutputFileName"></a><span class="summary-sig"><span class="summary-sig-name">getOutputFileName</span>(<span class=summary-sig-arg>originalFileName</span>,
<span class=summary-sig-arg>outputExtension</span>,
<span class=summary-sig-arg>index</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getSectionNumber"></a><span class="summary-sig"><span class="summary-sig-name">getSectionNumber</span>(<span class=summary-sig-arg>header</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="getSectionReference"></a><span class="summary-sig"><span class="summary-sig-name">getSectionReference</span>(<span class=summary-sig-arg>entry</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="index"></a><span class="summary-sig"><span class="summary-sig-name">index</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>filename</span>,
<span class=summary-sig-arg>chapterReference</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="makeSureDirectoryExists"></a><span class="summary-sig"><span class="summary-sig-name">makeSureDirectoryExists</span>(<span class=summary-sig-arg>filename</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="munge"></a><span class="summary-sig"><span class="summary-sig-name">munge</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>linkrel</span>,
<span class=summary-sig-arg>dir</span>,
<span class=summary-sig-arg>fullpath</span>,
<span class=summary-sig-arg>ext</span>,
<span class=summary-sig-arg>url</span>,
<span class=summary-sig-arg>config</span>,
<span class=summary-sig-arg>outfileGenerator</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="notes"></a><span class="summary-sig"><span class="summary-sig-name">notes</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="numberDocument"></a><span class="summary-sig"><span class="summary-sig-name">numberDocument</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>chapterNumber</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="parseFileAndReport"></a><span class="summary-sig"><span class="summary-sig-name">parseFileAndReport</span>(<span class=summary-sig-arg>filename</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="putInToC"></a><span class="summary-sig"><span class="summary-sig-name">putInToC</span>(<span class=summary-sig-arg>document</span>,
<span class=summary-sig-arg>toc</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="removeH1"></a><span class="summary-sig"><span class="summary-sig-name">removeH1</span>(<span class=summary-sig-arg>document</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setAuthors"></a><span class="summary-sig"><span class="summary-sig-name">setAuthors</span>(<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>authors</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setIndexLink"></a><span class="summary-sig"><span class="summary-sig-name">setIndexLink</span>(<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>indexFilename</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setTitle"></a><span class="summary-sig"><span class="summary-sig-name">setTitle</span>(<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>title</span>,
<span class=summary-sig-arg>chapterNumber</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="setVersion"></a><span class="summary-sig"><span class="summary-sig-name">setVersion</span>(<span class=summary-sig-arg>template</span>,
<span class=summary-sig-arg>version</span>)</span></code>
</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="getFirstAncestorWithSectionHeader"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getFirstAncestorWithSectionHeader</span>(<span class=sig-arg>entry</span>)</span>
</h3>
Go up ancestors until one with at least one <h2> is found,
then return the <h2> nodes
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="twisted.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://twistedmatrix.com/">Twisted 1.3.0rc1</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.0 on Sat May 15 20:08:05 2004</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>