--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric4.install.html Mon Dec 28 16:18:43 2009 +0000
@@ -0,0 +1,332 @@
+<?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.install</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.install</h1>
+<p>
+Installation script for the eric4 IDE and all eric4 related tools.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>apisDir</td></tr><tr><td>cfg</td></tr><tr><td>configLength</td></tr><tr><td>distDir</td></tr><tr><td>doCleanup</td></tr><tr><td>doCompile</td></tr><tr><td>modDir</td></tr><tr><td>platBinDir</td></tr><tr><td>progLanguages</td></tr><tr><td>progName</td></tr><tr><td>pyModDir</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr>
+<td><a href="#cleanUp">cleanUp</a></td>
+<td>Uninstall the old eric files.</td>
+</tr><tr>
+<td><a href="#compileUiDir">compileUiDir</a></td>
+<td>Creates Python modules from Qt Designer .ui files in a directory or directory tree.</td>
+</tr><tr>
+<td><a href="#compileUiFiles">compileUiFiles</a></td>
+<td>Compile the .ui files to Python sources.</td>
+</tr><tr>
+<td><a href="#compile_ui">compile_ui</a></td>
+<td>Local function to compile a single .ui file.</td>
+</tr><tr>
+<td><a href="#copyToFile">copyToFile</a></td>
+<td>Copy a string to a file.</td>
+</tr><tr>
+<td><a href="#copyTree">copyTree</a></td>
+<td>Copy Python, translation, documentation, wizards configuration, designer template files and DTDs of a directory tree.</td>
+</tr><tr>
+<td><a href="#createConfig">createConfig</a></td>
+<td>Create a config file with the respective config entries.</td>
+</tr><tr>
+<td><a href="#createGlobalPluginsDir">createGlobalPluginsDir</a></td>
+<td>Create the global plugins directory, if it doesn't exist.</td>
+</tr><tr>
+<td><a href="#createInstallConfig">createInstallConfig</a></td>
+<td>Create the installation config dictionary.</td>
+</tr><tr>
+<td><a href="#createPyWrapper">createPyWrapper</a></td>
+<td>Create an executable wrapper for a Python script.</td>
+</tr><tr>
+<td><a href="#doDependancyChecks">doDependancyChecks</a></td>
+<td>Perform some dependency checks.</td>
+</tr><tr>
+<td><a href="#initGlobals">initGlobals</a></td>
+<td>Sets the values of globals that need more than a simple assignment.</td>
+</tr><tr>
+<td><a href="#installEric">installEric</a></td>
+<td>Actually perform the installation steps.</td>
+</tr><tr>
+<td><a href="#main">main</a></td>
+<td>The main function of the script.</td>
+</tr><tr>
+<td><a href="#pyName">pyName</a></td>
+<td>Local function to create the Python source file name for the compiled .ui file.</td>
+</tr><tr>
+<td><a href="#usage">usage</a></td>
+<td>Display a usage message and exit.</td>
+</tr><tr>
+<td><a href="#wrapperName">wrapperName</a></td>
+<td>Create the platform specific name for the wrapper script.</td>
+</tr>
+</table>
+<hr /><hr />
+<a NAME="cleanUp" ID="cleanUp"></a>
+<h2>cleanUp</h2>
+<b>cleanUp</b>(<i></i>)
+<p>
+ Uninstall the old eric files.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="compileUiDir" ID="compileUiDir"></a>
+<h2>compileUiDir</h2>
+<b>compileUiDir</b>(<i>dir, recurse = False, map = None, **compileUi_args</i>)
+<p>
+ Creates Python modules from Qt Designer .ui files in a directory or
+ directory tree.
+</p><p>
+ Note: This function is a modified version of the one found in PyQt4.
+</p><dl>
+<dt><i>dir</i></dt>
+<dd>
+Name of the directory to scan for files whose name ends with
+ '.ui'. By default the generated Python module is created in the same
+ directory ending with '.py'.
+</dd><dt><i>recurse</i></dt>
+<dd>
+flag indicating that any sub-directories should be scanned.
+</dd><dt><i>map</i></dt>
+<dd>
+an optional callable that is passed the name of the directory
+ containing the '.ui' file and the name of the Python module that will be
+ created. The callable should return a tuple of the name of the directory
+ in which the Python module will be created and the (possibly modified)
+ name of the module.
+</dd><dt><i>compileUi_args</i></dt>
+<dd>
+any additional keyword arguments that are passed to
+ the compileUi() function that is called to create each Python module.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="compileUiFiles" ID="compileUiFiles"></a>
+<h2>compileUiFiles</h2>
+<b>compileUiFiles</b>(<i></i>)
+<p>
+ Compile the .ui files to Python sources.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="compile_ui" ID="compile_ui"></a>
+<h2>compile_ui</h2>
+<b>compile_ui</b>(<i>ui_dir, ui_file</i>)
+<p>
+ Local function to compile a single .ui file.
+</p><dl>
+<dt><i>ui_dir</i></dt>
+<dd>
+directory containing the .ui file (string)
+</dd><dt><i>ui_file</i></dt>
+<dd>
+file name of the .ui file (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="copyToFile" ID="copyToFile"></a>
+<h2>copyToFile</h2>
+<b>copyToFile</b>(<i>name, text</i>)
+<p>
+ Copy a string to a file.
+</p><dl>
+<dt><i>name</i></dt>
+<dd>
+the name of the file.
+</dd><dt><i>text</i></dt>
+<dd>
+the contents to copy to the file.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="copyTree" ID="copyTree"></a>
+<h2>copyTree</h2>
+<b>copyTree</b>(<i>src, dst, filters, excludeDirs=[]</i>)
+<p>
+ Copy Python, translation, documentation, wizards configuration,
+ designer template files and DTDs of a directory tree.
+</p><dl>
+<dt><i>src</i></dt>
+<dd>
+name of the source directory
+</dd><dt><i>dst</i></dt>
+<dd>
+name of the destination directory
+</dd><dt><i>filters</i></dt>
+<dd>
+list of filter pattern determining the files to be copied
+</dd><dt><i>excludeDirs</i></dt>
+<dd>
+list of (sub)directories to exclude from copying
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createConfig" ID="createConfig"></a>
+<h2>createConfig</h2>
+<b>createConfig</b>(<i></i>)
+<p>
+ Create a config file with the respective config entries.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createGlobalPluginsDir" ID="createGlobalPluginsDir"></a>
+<h2>createGlobalPluginsDir</h2>
+<b>createGlobalPluginsDir</b>(<i></i>)
+<p>
+ Create the global plugins directory, if it doesn't exist.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createInstallConfig" ID="createInstallConfig"></a>
+<h2>createInstallConfig</h2>
+<b>createInstallConfig</b>(<i></i>)
+<p>
+ Create the installation config dictionary.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="createPyWrapper" ID="createPyWrapper"></a>
+<h2>createPyWrapper</h2>
+<b>createPyWrapper</b>(<i>pydir, wfile</i>)
+<p>
+ Create an executable wrapper for a Python script.
+</p><dl>
+<dt><i>pydir</i></dt>
+<dd>
+the name of the directory where the Python script will eventually
+ be installed
+</dd><dt><i>wfile</i></dt>
+<dd>
+the basename of the wrapper
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the platform specific name of the wrapper
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="doDependancyChecks" ID="doDependancyChecks"></a>
+<h2>doDependancyChecks</h2>
+<b>doDependancyChecks</b>(<i></i>)
+<p>
+ Perform some dependency checks.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="initGlobals" ID="initGlobals"></a>
+<h2>initGlobals</h2>
+<b>initGlobals</b>(<i></i>)
+<p>
+ Sets the values of globals that need more than a simple assignment.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="installEric" ID="installEric"></a>
+<h2>installEric</h2>
+<b>installEric</b>(<i></i>)
+<p>
+ Actually perform the installation steps.
+</p>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="main" ID="main"></a>
+<h2>main</h2>
+<b>main</b>(<i>argv</i>)
+<p>
+ The main function of the script.
+</p><dl>
+<dt><i>argv</i></dt>
+<dd>
+the list of command line arguments.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="pyName" ID="pyName"></a>
+<h2>pyName</h2>
+<b>pyName</b>(<i>py_dir, py_file</i>)
+<p>
+ Local function to create the Python source file name for the compiled .ui file.
+</p><dl>
+<dt><i>py_dir</i></dt>
+<dd>
+suggested name of the directory (string)
+</dd><dt><i>py_file</i></dt>
+<dd>
+suggested name for the compile source file (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+tuple of directory name (string) and source file name (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="usage" ID="usage"></a>
+<h2>usage</h2>
+<b>usage</b>(<i>rcode = 2</i>)
+<p>
+ Display a usage message and exit.
+</p><dl>
+<dt><i>rcode</i></dt>
+<dd>
+the return code passed back to the calling process.
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr /><hr />
+<a NAME="wrapperName" ID="wrapperName"></a>
+<h2>wrapperName</h2>
+<b>wrapperName</b>(<i>dname, wfile</i>)
+<p>
+ Create the platform specific name for the wrapper script.
+</p><dl>
+<dt><i>dname</i></dt>
+<dd>
+name of the directory to place the wrapper into
+</dd><dt><i>wfile</i></dt>
+<dd>
+basename (without extension) of the wrapper script
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+the name of the wrapper script
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
