169 lines
5.5 KiB
HTML
Raw Normal View History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "httpqrc://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="httpqrc://www.w3.org/1999/xhtml">
2012-09-10 19:16:37 +02:00
<head>
<title>Help Python Console</title>
2012-09-30 16:47:58 +02:00
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<!--<script type="text/javascript" src="js/jquery-1.8.2.min.js"></script>
<script type="text/javascript" src="js/jquery.i18n.min.js"></script>-->
2012-09-10 19:16:37 +02:00
<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%;*/
}
2012-09-10 19:16:37 +02:00
</style>
</head>
<body>
<table id="header">
2012-09-10 19:16:37 +02:00
<tr>
<td>
2012-10-05 22:54:21 +02:00
<img src="qrc:/images/console/imgHelpDialog.png" />
2012-09-10 19:16:37 +02:00
</td>
<td>
2012-09-30 16:47:58 +02:00
<h2 id="headerTitle">Python Console for QGIS</h2>
2012-09-10 19:16:37 +02:00
</td>
</tr>
</table>
<p align="justify">
2012-09-30 16:47:58 +02:00
<span id="headerSubject">Python Console based on PyQScintilla2. (Developed by Salvatore Larosa)</span>
2012-09-11 16:05:52 +02:00
<br><br>
2012-09-30 16:47:58 +02:00
<span id="headerSubjectMain">To access Quantum GIS environment from this console
2012-09-10 19:16:37 +02:00
use qgis.utils.iface object (instance of QgisInterface class).
To import the class QgisInterface can also use the dedicated
2012-09-30 16:47:58 +02:00
button on the toolbar on the left.</span>
2012-09-10 19:16:37 +02:00
</p>
<table id="header">
<tr>
<td>
2012-09-30 16:47:58 +02:00
<h4 id="features">Features</h4>
</td>
</tr>
</table>
<p align="justify">
<ul>
2012-09-30 16:47:58 +02:00
<li><span id="featuresTitle">Auto-completion and highlighting syntax for the following APIs:</span>
<ol>
<li>Python</li>
<li>PyQGIS-master</li>
<li>PyQt4</li>
<li>QScintilla2</li>
<li>osgeo-gdal-ogr</li>
</ol>
</li>
<br>
2012-09-30 16:47:58 +02:00
<li><span id="featuresA">CTRL+SPACE to view the auto-completion list.</span></li>
<br>
2012-09-30 16:47:58 +02:00
<li><span id="featuresB">CTRL+ALT+SPACE to view the command history list.</span></li>
<br>
2012-09-30 16:47:58 +02:00
<li><span id="featuresC">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</span>
</li>
<br>
2012-09-30 16:47:58 +02:00
<li><span id="featuresD">Clears the command history by typing <b>_clear</b>.<br>
This command clears the command history from file ~/.qgis/console_history.txt</span>
</li>
<br>
2012-09-30 16:47:58 +02:00
<li><span id="featuresE">Clears completely command history by typing <b>_clearAll</b>.<br>
This command clears completely the command history. It has an irreversible effect.</span>
</li>
</ul>
</p>
<table id="header">
<tr>
<td>
2012-09-30 16:47:58 +02:00
<h4 id="toolbar">Toolbar</h4>
</td>
</tr>
</table>
2012-09-30 16:47:58 +02:00
<p><span id="toolbarTitle">The following is a description of the tools in the toolbar:</span></p>
<table width="100%" border="0" id="headerTool">
2012-09-10 19:16:37 +02:00
<tr>
<td><img src="qrc:/images/console/iconClearConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td colspan="2"><span id="toolbarClear">Tool to clear python console</span></td>
2012-09-10 19:16:37 +02:00
</tr>
<tr>
<td><img src="qrc:/images/console/iconClassConsole.png" /></td>
<td><img src="qrc:/images/console/iconIfaceConsole.png" /></td>
<td><span id="toolbarIfaceClass">Tool to import QgisInterface class</span></td>
2012-09-10 19:16:37 +02:00
</tr>
<tr>
<td></td>
<td><img src="qrc:/images/console/iconSextanteConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td><span id="toolbarSextClass">Tool to import Sextante class</span></td>
2012-09-14 01:18:04 +02:00
</tr>
<tr>
<td></td>
<td><img src="qrc:/images/console/iconQtCoreConsole.png" /></td>
<td><span id="toolbarQtCoreClass">Tool to import PyQt4.QtCore class</span></td>
</tr>
<tr>
<td></td>
<td><img src="qrc:/images/console/iconQtGuiConsole.png" /></td>
<td><span id="toolbarQtGuiClass">Tool to import PyQt4.QtGui class</span></td>
</tr>
2012-09-14 01:18:04 +02:00
<tr>
<td><img src="qrc:/images/console/iconScriptConsole.png" /></td>
<td><img src="qrc:/images/console/iconOpenConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td><span id="toolbarScriptOpen">Tool to open a python script and load in console</span></td>
2012-09-10 19:16:37 +02:00
</tr>
<tr>
<td></td>
<td><img src="qrc:/images/console/iconSaveConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td><span id="toolbarScriptSave">Tool to save a python script</span></td>
2012-09-10 19:16:37 +02:00
</tr>
<tr>
<td><img src="qrc:/images/console/iconHelpConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td colspan="2"><span id="toolbarHelp">Help</span></td>
2012-09-10 19:16:37 +02:00
</tr>
<tr>
<td><img src="qrc:/images/console/iconRunConsole.png" /></td>
2012-09-30 16:47:58 +02:00
<td colspan="2"><span id="toolbarRun">Run command (like Enter key pressed)</span></td>
2012-09-10 19:16:37 +02:00
</tr>
</table>
<br>
<table id="header">
<tr>
<td>
2012-09-30 16:47:58 +02:00
<h4 id="thanks">Acknowledgments</h4>
</td>
</tr>
</table>
<p>
2012-09-30 16:47:58 +02:00
<span id="thanksText">Thanks to Larry Shaffer who provided the API files.</span>
</p>
2012-09-10 19:16:37 +02:00
</body>
<script type="text/javascript">
var parameter = window.location.search.replace( "?", "" );
var langPathParameters = parameter.split("&");
var locale = langPathParameters[0].split("=");
var jQueryPath = langPathParameters[1].split("=");
var pathJs = jQueryPath[1];
var lang = locale[1].split("_")[0];
var jquery = document.createElement("script");
jquery.type = "text/javascript";
jquery.src = pathJs + "/resources/jQuery/jquery-1.8.2.min.js";
document.body.appendChild(jquery);
var jqueryi18n = document.createElement("script");
jqueryi18n.type = "text/javascript";
jqueryi18n.src = pathJs + "/resources/jQuery/jquery.i18n.min.js";
document.body.appendChild(jqueryi18n);
var properties = document.createElement("script");
properties.type = "text/javascript";
properties.src = "i18n/" + lang + ".properties";
document.body.appendChild(properties);
var encode = document.createElement("script");
encode.type = "text/javascript";
encode.src = "js/encoding.js";
document.body.appendChild(encode);
</script>
</html>