Salvatore Larosa 32deee72a5 New style for the toolbar icons
- update the help.htm
2012-09-28 14:06:49 +02:00

130 lines
3.3 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Help Python Console</title>
<style>
body{
font-family: verdana,arial,helvetica,sans-serif;
/*font-family:Verdana,Geneva,sans-serif;*/
font-size : 12px;
}
#header{
background: #cccccc;
width: 100%;
}
#headerTool td{
background: #f6f6f6;
/*width: 100%;*/
}
</style>
</head>
<body>
<table id="header">
<tr>
<td>
<img src="../iconConsole/imgHelpDialog.png" />
</td>
<td>
<h2>Python Console for QGIS</h2>
</td>
</tr>
</table>
<p align="justify">
Python Console based on pyScintilla. (Developed by Salvatore Larosa)
<br><br>
To access Quantum GIS environment from this console
use qgis.utils.iface object (instance of QgisInterface class).
To import the class QgisInterface can also use the dedicated
button on the toolbar on the left.
</p>
<table id="header">
<tr>
<td>
<h4>Features</h4>
</td>
</tr>
</table>
<p align="justify">
<ul>
<li>Auto-completion and highlighting syntax for the following APIs:
<ol>
<li>Python</li>
<li>PyQGIS-master</li>
<li>PyQt4</li>
<li>QScintilla2</li>
<li>osgeo-gdal-ogr</li>
</ol>
</li>
<br>
<li>CTRL+SPACE to view the auto-completion list.</li>
<br>
<li>CTRL+ALT+SPACE to view the command history list.</li>
<br>
<li>Saves the command history by typing <b>_save</b> or closing the widget.<br>
This command saves the history command in the file ~/.qgis/console_history.txt
</li>
<br>
<li>Clears the command history by typing <b>_clear</b>.<br>
This command clears the command history from file ~/.qgis/console_history.txt
</li>
<br>
<li>Clears completely command history by typing <b>_clearAll</b>.<br>
This command clears completely the command history. It has an irreversible effect.
</li>
</ul>
</p>
<table id="header">
<tr>
<td>
<h4>Toolbar</h4>
</td>
</tr>
</table>
<p>The following is a description of the tools in the toolbar:</p>
<table width="100%" border="0" id="headerTool">
<tr>
<td><img src="../iconConsole/iconClearConsole.png" /></td>
<td colspan="2">Tool to clear python console</td>
</tr>
<tr>
<td><img src="../iconConsole/iconClassConsole.png" /></td>
<td><img src="../iconConsole/iconIfaceConsole.png" /></td>
<td>Tool to import iface class</td>
</tr>
<tr>
<td></td>
<td><img src="../iconConsole/iconSextanteConsole.png" /></td>
<td>Tool to import Sextante class</td>
</tr>
<tr>
<td><img src="../iconConsole/iconScriptConsole.png" /></td>
<td><img src="../iconConsole/iconOpenConsole.png" /></td>
<td>Tool to open a python script and load in console</td>
</tr>
<tr>
<td></td>
<td><img src="../iconConsole/iconSaveConsole.png" /></td>
<td>Tool to save a python script</td>
</tr>
<tr>
<td><img src="../iconConsole/iconHelpConsole.png" /></td>
<td colspan="2">Help</td>
</tr>
<tr>
<td><img src="../iconConsole/iconRunConsole.png" /></td>
<td colspan="2">Run command (like Enter key pressed)</td>
</tr>
</table>
<br>
<table id="header">
<tr>
<td>
<h4>Acknowledgments</h4>
</td>
</tr>
</table>
<p>
Thanks to Larry Shaffer who provided the API files.
</p>
</body>
</html>