Documentation/Source/eric5.DocumentationTools.IndexGenerator.html

<?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>eric5.DocumentationTools.IndexGenerator</title>
<style>
b'body {\n    background:white;\n    margin: 0em 1em 10em 1em;\n    color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n    \na { color: #AA5500; }\n'
</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.DocumentationTools.IndexGenerator</h1>
<p>
&#77;&#111;&#100;&#117;&#108;&#101; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</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>&#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.</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>
    &#67;&#108;&#97;&#115;&#115; &#105;&#109;&#112;&#108;&#101;&#109;&#101;&#110;&#116;&#105;&#110;&#103; &#116;&#104;&#101; &#105;&#110;&#100;&#101;x &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114; &#102;&#111;&#114; &#116;&#104;&#101; &#98;&#117;&#105;&#108;&#116;&#105;&#110; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#111;&#114;.
</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>&#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;</td>
</tr><tr>
<td><a href="#IndexGenerator.__writeIndex">__writeIndex</a></td>
<td>&#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#110; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101; &#102;&#111;&#114; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.</td>
</tr><tr>
<td><a href="#IndexGenerator.remember">remember</a></td>
<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.</td>
</tr><tr>
<td><a href="#IndexGenerator.writeIndices">writeIndices</a></td>
<td>&#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.</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>
        &#67;&#111;&#110;&#115;&#116;&#114;&#117;&#99;&#116;&#111;&#114;
</p><dl>
<dt><i>outputDir</i></dt>
<dd>
&#84;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116; &#100;&#105;&#114;&#101;&#99;&#116;&#111;&#114;y &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#115;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>colors</i></dt>
<dd>
&#68;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#115;&#112;&#101;&#99;&#105;&#102;y&#105;&#110;&#103; &#116;&#104;&#101; v&#97;&#114;&#105;&#111;&#117;&#115; &#99;&#111;&#108;&#111;&#114;&#115; &#102;&#111;&#114; &#116;&#104;&#101; &#111;&#117;&#116;&#112;&#117;&#116;.
            (&#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y &#111;&#102; &#115;&#116;&#114;&#105;&#110;&#103;&#115;)
</dd><dt><i>stylesheet</i></dt>
<dd>
&#116;&#104;&#101; &#115;&#116;y&#108;&#101; &#116;&#111; &#98;&#101; &#117;&#115;&#101;&#100; &#102;&#111;&#114; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#112;&#97;&#103;&#101;&#115; (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd>
</dl><a NAME="IndexGenerator.__writeIndex" ID="IndexGenerator.__writeIndex"></a>
<h4>IndexGenerator.__writeIndex</h4>
<b>__writeIndex</b>(<i>packagename, package</i>)
<p>
        &#80;&#114;&#105;v&#97;&#116;&#101; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#110; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101; &#102;&#111;&#114; &#97; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
</p><dl>
<dt><i>packagename</i></dt>
<dd>
&#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>package</i></dt>
<dd>
&#65; &#100;&#105;&#99;&#116;&#105;&#111;&#110;&#97;&#114;y w&#105;&#116;&#104; &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#97;&#98;&#111;&#117;&#116; &#116;&#104;&#101; &#112;&#97;&#99;&#107;&#97;&#103;&#101;.
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
&#84;&#104;&#101; &#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101;&#100; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;.
</dd>
</dl><a NAME="IndexGenerator.remember" ID="IndexGenerator.remember"></a>
<h4>IndexGenerator.remember</h4>
<b>remember</b>(<i>file, moduleDocument, basename=""</i>)
<p>
        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114; &#97; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#97;&#116;&#105;&#111;&#110; &#102;&#105;&#108;&#101;.
</p><dl>
<dt><i>file</i></dt>
<dd>
&#84;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#116;&#111; &#98;&#101; &#114;&#101;&#109;&#101;&#109;&#98;&#101;&#114;&#101;&#100;. (&#115;&#116;&#114;&#105;&#110;&#103;)
</dd><dt><i>moduleDocument</i></dt>
<dd>
&#84;&#104;&#101; &#77;&#111;&#100;&#117;&#108;&#101;&#68;&#111;&#99;&#117;&#109;&#101;&#110;&#116; &#111;&#98;&#106;&#101;&#99;&#116; &#99;&#111;&#110;&#116;&#97;&#105;&#110;&#105;&#110;&#103; &#116;&#104;&#101;
            &#105;&#110;&#102;&#111;&#114;&#109;&#97;&#116;&#105;&#111;&#110; &#102;&#111;&#114; &#116;&#104;&#101; &#102;&#105;&#108;&#101;.
</dd><dt><i>basename</i></dt>
<dd>
&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
</dd>
</dl><a NAME="IndexGenerator.writeIndices" ID="IndexGenerator.writeIndices"></a>
<h4>IndexGenerator.writeIndices</h4>
<b>writeIndices</b>(<i>basename = ""</i>)
<p>
        &#80;&#117;&#98;&#108;&#105;&#99; &#109;&#101;&#116;&#104;&#111;&#100; &#116;&#111; &#103;&#101;&#110;&#101;&#114;&#97;&#116;&#101; &#97;&#108;&#108; &#105;&#110;&#100;&#101;x &#102;&#105;&#108;&#101;&#115;.
</p><dl>
<dt><i>basename</i></dt>
<dd>
&#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#111;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101; &#104;&#105;&#101;&#114;&#97;&#114;&#99;&#104;y &#116;&#111; &#98;&#101; &#100;&#111;&#99;&#117;&#109;&#101;&#110;&#116;&#101;&#100;.
            &#84;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101; &#105;&#115; &#115;&#116;&#114;&#105;&#112;&#112;&#101;&#100; &#111;&#102;&#102; &#116;&#104;&#101; &#102;&#105;&#108;&#101;&#110;&#97;&#109;&#101; &#105;&#102; &#105;&#116; &#115;&#116;&#97;&#114;&#116;&#115; w&#105;&#116;&#104;
            &#116;&#104;&#101; &#98;&#97;&#115;&#101;&#110;&#97;&#109;&#101;.
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>