91 lines
7.8 KiB
HTML
91 lines
7.8 KiB
HTML
|
|
||
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||
|
|
<html><head><title>Python: module fabmetheus_utilities.fabmetheus_tools.wikifier</title>
|
||
|
|
</head><body bgcolor="#f0f0f8">
|
||
|
|
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
||
|
|
<tr bgcolor="#7799ee">
|
||
|
|
<td valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="fabmetheus_utilities.html"><font color="#ffffff">fabmetheus_utilities</font></a>.<a href="fabmetheus_utilities.fabmetheus_tools.html"><font color="#ffffff">fabmetheus_tools</font></a>.wikifier</strong></big></big> ($Date: 2008/21/04 $)</font></td
|
||
|
|
><td align=right valign=bottom
|
||
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/fabmetheus_utilities/fabmetheus_tools/wikifier.py">/home/enrique/Desktop/backup/babbleold/script/reprap/fabmetheus/fabmetheus_utilities/fabmetheus_tools/wikifier.py</a></font></td></tr></table>
|
||
|
|
<p><tt>Wikifier is a script to add spaces to the pydoc files and move them to the documentation folder.</tt></p>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#aa55cc">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="__init__.html">__init__</a><br>
|
||
|
|
<a href="fabmetheus_utilities.archive.html">fabmetheus_utilities.archive</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="cStringIO.html">cStringIO</a><br>
|
||
|
|
<a href="fabmetheus_utilities.gcodec.html">fabmetheus_utilities.gcodec</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="os.html">os</a><br>
|
||
|
|
<a href="fabmetheus_utilities.settings.html">fabmetheus_utilities.settings</a><br>
|
||
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ee77aa">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="fabmetheus_utilities.fabmetheus_tools.wikifier.html#Heading">Heading</a>
|
||
|
|
</font></dt></dl>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="Heading">class <strong>Heading</strong></a></font></td></tr>
|
||
|
|
|
||
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
||
|
|
<td colspan=2><tt>A class to hold the heading and subheadings.<br> </tt></td></tr>
|
||
|
|
<tr><td> </td>
|
||
|
|
<td width="100%">Methods defined here:<br>
|
||
|
|
<dl><dt><a name="Heading-__init__"><strong>__init__</strong></a>(self, depth<font color="#909090">=0</font>)</dt><dd><tt>Initialize.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="Heading-addToOutput"><strong>addToOutput</strong></a>(self, output)</dt><dd><tt>Add to the output.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="Heading-getFromLine"><strong>getFromLine</strong></a>(self, headingLineTable, line)</dt><dd><tt>Get the heading from a line.</tt></dd></dl>
|
||
|
|
|
||
|
|
</td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#eeaa77">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl><dt><a name="-addToHeadings"><strong>addToHeadings</strong></a>(headingLineTable, headings, line)</dt><dd><tt>Add the line to the headings.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getLinkLine"><strong>getLinkLine</strong></a>(line)</dt><dd><tt>Get the link line with the wiki style link converted into a hypertext link.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getNavigationHypertext"><strong>getNavigationHypertext</strong></a>(fileText, transferredFileNameIndex, transferredFileNames)</dt><dd><tt>Get the hypertext help with navigation lines.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getNavigationLine"><strong>getNavigationLine</strong></a>(contentsLinkText, previousLinkText, nextLinkText)</dt><dd><tt>Get the wrapped pydoc hypertext help.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getNextLinkText"><strong>getNextLinkText</strong></a>(hypertextFiles, nextIndex)</dt><dd><tt>Get the next link text.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-getWrappedHypertext"><strong>getWrappedHypertext</strong></a>(fileText, hypertextFileIndex, hypertextFiles)</dt><dd><tt>Get the wrapped pydoc hypertext help.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-main"><strong>main</strong></a>()</dt><dd><tt>Display the craft dialog.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-readWriteDeleteHypertextHelp"><strong>readWriteDeleteHypertextHelp</strong></a>(documentDirectoryPath, hypertextFileIndex, hypertextFiles, transferredFileNames)</dt><dd><tt>Read the pydoc hypertext help documents, write them in the documentation folder then delete the originals.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-readWriteNavigationHelp"><strong>readWriteNavigationHelp</strong></a>(documentDirectoryPath, transferredFileNameIndex, transferredFileNames)</dt><dd><tt>Read the hypertext help documents, and add the navigation lines to them.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-removeFilesInDirectory"><strong>removeFilesInDirectory</strong></a>(directoryPath)</dt><dd><tt>Remove all the files in a directory.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-writeContentsFile"><strong>writeContentsFile</strong></a>(documentDirectoryPath, hypertextFiles)</dt><dd><tt>Write the contents file.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-writeContentsLine"><strong>writeContentsLine</strong></a>(hypertextFile, output)</dt><dd><tt>Write a line of the contents file.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-writeHypertext"><strong>writeHypertext</strong></a>()</dt><dd><tt>Run pydoc, then read, write and delete each of the files.</tt></dd></dl>
|
||
|
|
</td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#55aa55">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><strong>__author__</strong> = 'Enrique Perez (perez_enrique@yahoo.com)'<br>
|
||
|
|
<strong>__date__</strong> = '$Date: 2008/21/04 $'<br>
|
||
|
|
<strong>__license__</strong> = 'GNU Affero General Public License http://www.gnu.org/licenses/agpl.html'<br>
|
||
|
|
<strong>absolute_import</strong> = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)<br>
|
||
|
|
<strong>globalWikiLinkStart</strong> = '[<a href='</td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#7799ee">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%">Enrique Perez (perez_enrique@yahoo.com)</td></tr></table>
|
||
|
|
</body></html>
|