mirror of
https://github.com/qgis/QGIS.git
synced 2025-04-15 00:04:00 -04:00
65d3535fc5
- integrate PythonConsole help into main translation - allow referencing QGIS images in context help(viewer)
172 lines
5.0 KiB
Plaintext
172 lines
5.0 KiB
Plaintext
<!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" />
|
|
|
|
<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 class="_title">Python Console for QGIS</span>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table>
|
|
<tr>
|
|
<td>
|
|
<p align="justify">
|
|
Python Console based on PyQScintilla2.
|
|
<br><br>
|
|
To access the QGIS 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>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/imgHelpConsole.png" /></td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<p align="justify">
|
|
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.
|
|
<img src="qrc:/images/themes/default/console/imgHelpMenu.png"><br>
|
|
Input area pane is the interactive python shell for input commands.
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<table id="header">
|
|
<tr>
|
|
<td>
|
|
<span class="_titleP">Features</span>
|
|
</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>Open QGIS API documentation by typing '_api'.</li>
|
|
<br>
|
|
<li>Open PyQGIS Cookbook by typing '_pyqgis'.</li>
|
|
<br>
|
|
<li>Saves the command history by typing '_save' or closing the widget.
|
|
This command saves the history command in the file ~/.qgis2/console_history.txt</li>
|
|
<br>
|
|
<li>Clears the command history by typing <b>_clear</b>.
|
|
This command clears the command history from file ~/.qgis2/console_history.txt</li>
|
|
<br>
|
|
<li>Clears completely command history by typing '_clearAll'.
|
|
This command clears completely the command history. It has an irreversible effect.</li>
|
|
</ul>
|
|
</p>
|
|
<table id="header">
|
|
<tr>
|
|
<td>
|
|
<span class="_titleP">Toolbar</span>
|
|
</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="qrc:/images/themes/default/console/iconClearConsole.png" /></td>
|
|
<td colspan="2">Tool to clear python console</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>Tool to import iface class</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconSextanteConsole.png" /></td>
|
|
<td>Tool to import Sextante class</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconQtCoreConsole.png" /></td>
|
|
<td>Tool to import PyQt4.QtCore class</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconQtGuiConsole.png" /></td>
|
|
<td>Tool to import PyQt4.QtGui class</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>Tool to open a python script and load in console</td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td><img src="qrc:/images/themes/default/console/iconSaveConsole.png" /></td>
|
|
<td>Tool to save a python script</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconSettingsConsole.png" /></td>
|
|
<td colspan="2">Settings</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconHelpConsole.png" /></td>
|
|
<td colspan="2">Help</td>
|
|
</tr>
|
|
<tr>
|
|
<td><img src="qrc:/images/themes/default/console/iconRunConsole.png" /></td>
|
|
<td colspan="2">Run command (like Enter key pressed)</td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|