Hi Alexander,<br><br><div class="gmail_quote">On Sun, May 13, 2012 at 3:03 AM, Alexander Bruy <span dir="ltr"><<a href="mailto:alexander.bruy@gmail.com" target="_blank">alexander.bruy@gmail.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi all,<br>
<br>
regarding to PyQGIS CookBook [0] plugin documentation can<br>
be written as HTML files and to open help developer should<br>
use method showPluginHelp() from qgis.utils module.<br>
<br>
In same time showPluginHelp() used deprecated method openURL()<br>
from QgsInterface class [1]. And as I can see there are no alternatives<br>
for this method. So what is best solution for displaying Python plugin<br>
help in long-term period? Use showPluginHelp() as suggested in<br>
cookbook or implement own method directly in plugins?<br>
<br>
[0] <a href="http://www.qgis.org/pyqgis-cookbook/plugins.html#documentation" target="_blank">http://www.qgis.org/pyqgis-cookbook/plugins.html#documentation</a><br>
[1] <a href="http://qgis.org/api/classQgisInterface.html#374a28be05fac25b26f271f7ff19cd6d" target="_blank">http://qgis.org/api/classQgisInterface.html#374a28be05fac25b26f271f7ff19cd6d</a><span class="HOEnZb"><font color="#888888"><br>
</font></span></blockquote><div><br>You can use QDesktopServices [0] in lieu of QGIS openURL(), but I think you probably know this already:<br>
<br>
QtGui.QDesktopServices.openUrl(QUrl(some_url))<br><br>As part of my Plugin Editor tools, I have designed a lightweight web browser for displaying HTML help. It allows you to load pre-defined bookmarks, and has several useful tools for viewing help and tutorials from within plugins, but does not support several 'normal' browser features, like downloads.<br>
<br>It is the first PyQGIS shared widget in the sister plugin to Plugin Editor, called Plugin Library. The idea behind the Library is to offer, via a PyQt GUI, a method to demo and browse available shared widgets, modules and snippets. Once the Library is installed, it acts like a PyQGIS virtual Python environment, from which other developers can use to import its different components into their plugins. It is an attempt to share code amongst Python plugin developers (without bothering the C++ coders to include into the GUI core), speed the development of plugins, and offer users similar GUIs across plugins (like a help browser).<br>
<br>I'm not done with the Library plugin, but I am pretty much done with the first version of Help Browser (except for its help :^). Please download it and try it out, if you like [1]. Right now, it is just a package, but will later be a sub-package of the Library, accessible with:<br>
<br>from plugin_library.widgets.help_browser.help_browser \<br> import HelpBrowser<br><br>I have only tested it on Mac (10.7 and 10.6.8). Currently, on Mac with QGIS 1.8, any access to external web sites crashes QGIS. Works locally, though.<br>
<br>[0] <a href="http://qt-project.org/doc/qt-4.8/qdesktopservices.html">http://qt-project.org/doc/qt-4.8/qdesktopservices.html</a><br>[1] <a href="http://dl.dropbox.com/u/4058089/qgis/help_browser.zip">http://dl.dropbox.com/u/4058089/qgis/help_browser.zip</a><br>
<br>Regards,<br><br>Larry Shaffer<br>Dakota Cartography<br>Black Hills, South Dakota <br></div></div>