<div dir="ltr"><div><div>Although the right side panel still didn't show, I did get the "Help" tab to work, and I also found a <span class="gmail-pl-en">getParameterDescriptions</span>() method in the source code that might do the trick.<br><br></div>Thanks for your help!<br><br></div>André<br></div><div class="gmail_extra"><br><div class="gmail_quote">2018-03-18 2:54 GMT-03:00 Luke Pinner <span dir="ltr"><<a href="mailto:lukepinnerau@gmail.com" target="_blank">lukepinnerau@gmail.com</a>></span>:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr">Judging by the 2.18 code[1], it looks like you would do something like:<div><div><br></div><div> def help(self):</div><div> return True, QUrl.fromLocalFile("/path/to/<wbr>my_long_help.html").toString()</div><div><br></div><div> def shortHelp(self):</div><span class=""><div> return "My short help string for the right side of the dialog" </div><div> #or</div><div> return open("/path/to/myshorthelp.<wbr>txt").read()</div><div><br></div><div><br></div></span><div>[1] <a href="https://github.com/qgis/QGIS/blob/release-2_18/python/plugins/processing/core/GeoAlgorithm.py#L111" target="_blank">https://github.com/qgis/<wbr>QGIS/blob/release-2_18/python/<wbr>plugins/processing/core/<wbr>GeoAlgorithm.py#L111</a></div><div><div class="h5"><div><br></div><div><br></div><br><div class="gmail_quote"><div dir="ltr">On Sun, 18 Mar 2018 at 16:07 Luke Pinner <<a href="mailto:lukepinnerau@gmail.com" target="_blank">lukepinnerau@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div dir="auto">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.<div dir="auto"><span style="font-family:consolas,"liberation mono",courier,monospace;background-color:rgb(255,255,255);font-size:14px;color:rgb(215,58,73)"><br></span></div><div dir="auto"><span style="font-family:consolas,"liberation mono",courier,monospace;background-color:rgb(255,255,255);font-size:14px;color:rgb(215,58,73)"><br></span></div><div dir="auto"><div dir="auto"><pre style="word-wrap:normal;margin-top:0px;margin-bottom:0px;padding:15px 0px;background-color:rgb(255,255,255)"><div style="padding:0px 15px" dir="auto"><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal">from qgis.PyQt.QtCore import QUrl</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"><br></span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal">class MyAlg(etc...) </span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> etc...</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"><br></span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> def shortHelpString(self)</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> return "My short help string for the right side of the dialog" </span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> #or</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> return open("/path/to/myshorthelp.<wbr>txt").read()</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"><br></span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal">And</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"><br></span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> def helpUrl(self):</span></font></div><div dir="auto"><font face="consolas, liberation mono, courier, monospace" color="#d73a49"><span style="font-size:14px;white-space:normal"> return QUrl.fromLocalFile("/path/to/<wbr>my_long_help.html").toString()</span></font></div><div style="font-family:consolas,"liberation mono",courier,monospace;font-size:14px"><br></div></div></pre></div></div></div></div><div dir="ltr"><div class="gmail_extra"><br><div class="gmail_quote">On 18 Mar. 2018 15:31, "André William" <<a href="mailto:wss.andre@gmail.com" target="_blank">wss.andre@gmail.com</a>> wrote:<br type="attribution"><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><div><div><div><div>Hi all,<br><br></div>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.<br><br></div>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_<wbr>plugin" folders, but without success.<br><br></div>Implementing the helpString() and helpUrl() methods in my GeoAlgorithm class didn't work either.<br><br></div>Am I missing something? Sorry if it's a noob question.<br></div><div></div><div><br></div>André<br></div>
<br>______________________________<wbr>_________________<br>
QGIS-Developer mailing list<br>
<a href="mailto:QGIS-Developer@lists.osgeo.org" target="_blank">QGIS-Developer@lists.osgeo.org</a><br>
List info: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" target="_blank">https://lists.osgeo.org/<wbr>mailman/listinfo/qgis-<wbr>developer</a><br>
Unsubscribe: <a href="https://lists.osgeo.org/mailman/listinfo/qgis-developer" rel="noreferrer" target="_blank">https://lists.osgeo.org/<wbr>mailman/listinfo/qgis-<wbr>developer</a><br></blockquote></div></div>
</div></blockquote></div></div></div></div></div>
</blockquote></div><br></div>