[QGIS-Developer] Processing algorithm plugin help

[André William]

Although the right side panel still didn't show, I did get the "Help" tab
to work, and I also found a getParameterDescriptions() method in the source
code that might do the trick.

Thanks for your help!

André

2018-03-18 2:54 GMT-03:00 Luke Pinner <lukepinnerau at gmail.com>:

> Judging by the 2.18 code[1], it looks like you would do something like:
>
>    def help(self):
>         return True, QUrl.fromLocalFile("/path/to/
> my_long_help.html").toString()
>
>     def shortHelp(self):
>         return "My short help string for the right side of the dialog"
>         #or
>         return open("/path/to/myshorthelp.txt").read()
>
>
> [1] https://github.com/qgis/QGIS/blob/release-2_18/python/
> plugins/processing/core/GeoAlgorithm.py#L111
>
>
>
> On Sun, 18 Mar 2018 at 16:07 Luke Pinner <lukepinnerau at gmail.com> wrote:
>
>> In QGIS 3.0 I use something like the following. I don't know if it will
>> be of any use for QGIS 2x though.
>>
>>
>> from qgis.PyQt.QtCore import QUrl
>>
>> class MyAlg(etc...)
>>     etc...
>>
>>     def shortHelpString(self)
>>         return "My short help string for the right side of the dialog"
>>         #or
>>         return open("/path/to/myshorthelp.txt").read()
>>
>> And
>>
>>     def helpUrl(self):
>>         return QUrl.fromLocalFile("/path/to/my_long_help.html").toString()
>>
>>
>> On 18 Mar. 2018 15:31, "André William" <wss.andre at gmail.com> wrote:
>>
>>> Hi all,
>>>
>>> I developed a processing algorithm plugin using the Plugin Builder but
>>> I'm having trouble setting up the Help panel which usually shows on the
>>> right side of the windows, or at least the a help button pointing to a
>>> static file.
>>>
>>> I've tried creating the .py.help file with the same name as my algorithm
>>> and provider files and placing them in both the
>>> "~/.qgis2/processing/scripts" and "~/.qgis2/python/plugins/my_plugin"
>>> folders, but without success.
>>>
>>> Implementing the helpString() and helpUrl() methods in my GeoAlgorithm
>>> class didn't work either.
>>>
>>> Am I missing something? Sorry if it's a noob question.
>>>
>>> André
>>>
>>> _______________________________________________
>>> QGIS-Developer mailing list
>>> QGIS-Developer at lists.osgeo.org
>>> List info: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>>> Unsubscribe: https://lists.osgeo.org/mailman/listinfo/qgis-developer
>>>
>>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180318/17f793a0/attachment-0001.html>