diff -r bc6196164237 -r 0d9daebf5b8c Documentation/Source/eric4.DocumentationTools.IndexGenerator.html
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.DocumentationTools.IndexGenerator.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,139 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric4.DocumentationTools.IndexGenerator</title>
+<style>
+body {
+ background:white;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #4FA4FF; }
+h2 { color: white; background: #4FA4FF; }
+h3 { color: white; background: #00557F; }
+h4 { color: white; background: #00557F; }
+
+a { color: #AA5500; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric4.DocumentationTools.IndexGenerator</h1>
+<p>
+Module implementing the index generator for the builtin documentation generator.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#IndexGenerator">IndexGenerator</a></td>
+<td>Class implementing the index generator for the builtin documentation generator.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="IndexGenerator" ID="IndexGenerator"></a>
+<h2>IndexGenerator</h2>
+<p>
+ Class implementing the index generator for the builtin documentation generator.
+</p>
+<h3>Derived from</h3>
+object
+<h3>Class Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#IndexGenerator.__init__">IndexGenerator</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td>
+<td>Private method to generate an index file for a package.</td>
+</tr><tr>
+<td><a href="#IndexGenerator.remember">remember</a></td>
+<td>Public method to remember a documentation file.</td>
+</tr><tr>
+<td><a href="#IndexGenerator.writeIndices">writeIndices</a></td>
+<td>Public method to generate all index files.</td>
+</tr>
+</table>
+<a NAME="IndexGenerator.__init__" ID="IndexGenerator.__init__"></a>
+<h4>IndexGenerator (Constructor)</h4>
+<b>IndexGenerator</b>(<i>outputDir, colors, stylesheet = None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>outputDir</i></dt>
+<dd>
+The output directory for the files. (string)
+</dd><dt><i>colors</i></dt>
+<dd>
+Dictionary specifying the various colors for the output.
+ (dictionary of strings)
+</dd><dt><i>stylesheet</i></dt>
+<dd>
+the style to be used for the generated pages (string)
+</dd>
+</dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a>
+<h4>IndexGenerator.__writeIndex</h4>
+<b>__writeIndex</b>(<i>packagename, package</i>)
+<p>
+ Private method to generate an index file for a package.
+</p><dl>
+<dt><i>packagename</i></dt>
+<dd>
+The name of the package. (string)
+</dd><dt><i>package</i></dt>
+<dd>
+A dictionary with information about the package.
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+The name of the generated index file.
+</dd>
+</dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a>
+<h4>IndexGenerator.remember</h4>
+<b>remember</b>(<i>file, moduleDocument, basename=""</i>)
+<p>
+ Public method to remember a documentation file.
+</p><dl>
+<dt><i>file</i></dt>
+<dd>
+The filename to be remembered. (string)
+</dd><dt><i>moduleDocument</i></dt>
+<dd>
+The ModuleDocument object containing the
+ information for the file.
+</dd><dt><i>basename</i></dt>
+<dd>
+The basename of the file hierarchy to be documented.
+ The basename is stripped off the filename if it starts with
+ the basename.
+</dd>
+</dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
+<h4>IndexGenerator.writeIndices</h4>
+<b>writeIndices</b>(<i>basename = ""</i>)
+<p>
+ Public method to generate all index files.
+</p><dl>
+<dt><i>basename</i></dt>
+<dd>
+The basename of the file hierarchy to be documented.
+ The basename is stripped off the filename if it starts with
+ the basename.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
