Skip to content

Commit

Permalink
Update help for console
Browse files Browse the repository at this point in the history
- header icon changed
- re-organized text
  • Loading branch information
slarosa committed Sep 26, 2012
1 parent a0566c7 commit f93cdff
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 12 deletions.
60 changes: 48 additions & 12 deletions python/helpConsole/help.htm
Expand Up @@ -8,10 +8,14 @@
/*font-family:Verdana,Geneva,sans-serif;*/
font-size : 12px;
}
#header{
background: #c6c6c6;
width: 100%;
}
</style>
</head>
<body>
<table>
<table id="header">
<tr>
<td>
<img src="../iconConsole/imgHelpDialog.png" />
Expand All @@ -22,22 +26,43 @@ <h2>Python Console for QGIS</h2>
</tr>
</table>
<p align="justify">
Now you can use auto-completion and highlighting for syntax in console!!!
<br>
(Thanks to Larry Shaffer who provided the API files)
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.
<br><br>
To save history commands type '<b>_save</b>' in console or close this widget.
<br><br>
To clear history commands type '<b>_clear</b>' in console.
<br><br>
The following is a description of the tools in the toolbar:
</p>
<table width="100%" bordercolor="#000" border="1">
<table id="header">
<tr>
<td>
<h4>Features</h4>
</td>
</tr>
</table>
<p align="justify">
<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>
<li>Saves command history by typing <b>_save</b> or closing the widget.</li>
<br>
<li>Clears command history by typing <b>_clear</b>.</li>
</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%">
<tr>
<td><img src="../iconConsole/iconClearConsole.png" /></td>
<td>Tool to clear python console</td>
Expand Down Expand Up @@ -67,5 +92,16 @@ <h2>Python Console for QGIS</h2>
<td>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>
</html>
Binary file modified python/iconConsole/imgHelpDialog.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f93cdff

Please sign in to comment.