[Qgis-developer] Best Practice for QGIS Plugin Help Documentation

[Chris Crook]

Hi Calvin

Method 2 is well supported by QGIS.  Put the help in index.html in the plugin directory, then

def showMyPluginHelp(self):
    from qgis import utils
    utils.showPluginHelp()

The showPluginHelp function will look for index.html by default, but you can specify a filename to use instead of index.
It also has a section argument which will go to an html anchor in the help file (<a name="mysection">...</a>

https://github.com/qgis/QGIS/blob/master/python/utils.py#L441

I'm not sure if this is in the PyQt developers cookbook or in plugin builder?

Cheers
Chri
________________________________________
From: Qgis-developer [qgis-developer-bounces at lists.osgeo.org] On Behalf Of C Hamilton [adenaculture at gmail.com]
Sent: 19 November 2016 09:13
To: qgis-developer
Subject: [Qgis-developer] Best Practice for QGIS Plugin Help Documentation

As part of my plugins I want to have a Help button that displays the documentation. What method do you recommend? I see various authors do it differently. I see three methods for when a help button is clicked on.

1. Launch a web browser to point to the documentation on the web.
2. Have the documentation as a part of the plugin and launch a web browser to view it.
3. Display a PyQt window with the documentation in it.

I don't consider #1 as a good option because it fails if you happen to be disconnected from the web. What are your thoughts on #2 or #3 or do you have a better option?

Thanks,

Calvin

This message contains information, which may be in confidence and may be subject to legal privilege. If you are not the intended recipient, you must not peruse, use, disseminate, distribute or copy this message. If you have received this message in error, please notify us immediately (Phone 0800 665 463 or info at linz.govt.nz) and destroy the original message. LINZ accepts no responsibility for changes to this email, or for any attachments, after its transmission from LINZ. Thank You.