mirror of
https://github.com/qgis/QGIS.git
synced 2025-02-27 00:33:48 -05:00
202 lines
6.9 KiB
HTML
202 lines
6.9 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>
|
|
<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>-->
|
|
|
|
<style>
|
|
body{
|
|
font-family: 'Trebuchet MS', sans-serif;
|
|
font-size : 12px;
|
|
}
|
|
#header{
|
|
background: #f6f6f6;
|
|
border-bottom: 3px solid #000;
|
|
width: 100%;
|
|
}
|
|
#headerTool td{
|
|
background: #f6f6f6;
|
|
/*width: 100%;*/
|
|
}
|
|
._titleP {
|
|
padding: 5px;
|
|
font-size: 15px;
|
|
font-weight: bold;
|
|
color: #000;
|
|
}
|
|
._title {
|
|
font-size: 20px;
|
|
font-weight: bold;
|
|
color: #000;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<table id="header">
|
|
<tr>
|
|
<td>
|
|
<img src="qrc:/images/themes/default/console/imgHelpDialog.png" />
|
|
</td>
|
|
<td>
|
|
<span id="headerTitle" class="_title">Python Console for QGIS</span>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<p align="justify">
|
|
<span id="headerSubject">Python Console based on PyQScintilla2.</span>
|
|
<br><br>
|
|
<span id="headerSubjectMain">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.</span>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/imgHelpConsole.png" /></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p align="justify">
|
|
<span id="headerSubjectA">The console is split in two main panes, output and input areas.
|
|
Both are resizable by using the horizontal splitter.
|
|
Output area pane is a widget read-only which shows the commands output.
|
|
You can drag and drop or copy text into input area (no matter if selected text contains >>> or ...).
|
|
Use 'Share on codepad' from contextual menu for sharing snippets code.
|
|
The context menu looks like the image below.</span><br><br>
|
|
<img src="qrc:/images/themes/default/console/imgHelpMenu.png"><br>
|
|
<span id="headerSubjectB">Input area pane is the interactive python shell for input commands.</span>
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table id="header">
|
|
<tr>
|
|
<td>
|
|
<span id="features" class="_titleP">Features</span>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<p align="justify">
|
|
<ul>
|
|
<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>
|
|
<li><span id="featuresA">CTRL+SPACE to view the auto-completion list.</span></li>
|
|
<br>
|
|
<li><span id="featuresB">CTRL+ALT+SPACE to view the command history list.</span></li>
|
|
<br>
|
|
<li><span id="featuresLoadAPI">Open Quantum GIS API documentation by typing <b>_api</b>.</span></li>
|
|
<br>
|
|
<li><span id="featuresLoadCookBook">Open PyQGIS Cookbook by typing <b>_pyqgis</b>.</span>
|
|
</li>
|
|
<br>
|
|
<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>
|
|
<li><span id="featuresD">Clears the command history by typing <b>_clear</b>.<br>
|
|
This command clears the temporary command history</span>
|
|
</li>
|
|
<br>
|
|
<li><span id="featuresE">Clears completely command history by typing <b>_clearAll</b>.<br>
|
|
This command clears completely the command history (both temporary and ~/.qgis/console_history.txt).
|
|
It has an irreversible effect.</span>
|
|
</li>
|
|
</ul>
|
|
</p>
|
|
<table id="header">
|
|
<tr>
|
|
<td>
|
|
<span id="toolbar" class="_titleP">Toolbar</span>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<p><span id="toolbarTitle">The following is a description of the tools in the toolbar:</span></p>
|
|
<table width="100%" border="0" id="headerTool">
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconClearConsole.png" /></td>
|
|
<td colspan="2"><span id="toolbarClear">Tool to clear python console</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconClassConsole.png" /></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconIfaceConsole.png" /></td>
|
|
<td><span id="toolbarIfaceClass">Tool to import QgisInterface class</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconSextanteConsole.png" /></td>
|
|
<td><span id="toolbarSextClass">Tool to import Sextante class</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/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/themes/default/console/iconQtGuiConsole.png" /></td>
|
|
<td><span id="toolbarQtGuiClass">Tool to import PyQt4.QtGui class</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconScriptConsole.png" /></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconOpenConsole.png" /></td>
|
|
<td><span id="toolbarScriptOpen">Tool to open a python script and load in console</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconSaveConsole.png" /></td>
|
|
<td><span id="toolbarScriptSave">Tool to save a python script</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconSettingsConsole.png" /></td>
|
|
<td colspan="2"><span id="toolbarSettings">Settings</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconHelpConsole.png" /></td>
|
|
<td colspan="2"><span id="toolbarHelp">Help</span></td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconRunConsole.png" /></td>
|
|
<td colspan="2"><span id="toolbarRun">Run command (like Enter key pressed)</span></td>
|
|
</tr>
|
|
</table>
|
|
</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];
|
|
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>
|