[QGIS-Developer] Processing algorithm plugin help

[André William]

I was already doing something quite similar but unfortunately it still
doesn't work. No help panel and no help button, just the parameters.
Is there anything else I should do on the defineCharacteristics() method
maybe?
As for the QGIS version, I'm still using 2.18. Could this be the problem?

Thanks for the input!
André

class TestlAlgorithm(GeoAlgorithm):


>     INPUT_LAYER = ' INPUT _LAYER'
>     OUTPUT_LAYER = 'OUTPUT_LAYER'
>
>     def helpString(self):
>         return "Test 321"
>
>     def shortHelpString(self):
>         return "Test 123"
>
>     def helpUrl(self):
>         return QUrl.fromLocalFile("file:file.txt").toString()
>

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

> 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/5089638f/attachment.html>