<div dir="ltr"><div style="font-family:"Calibri","sans-serif""><div dir="ltr">
<div dir="ltr"><div style="font-family:"Calibri","sans-serif"" dir="ltr"><div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">
<div dir="ltr">Hi QGIS-ers,<br></div><div dir="ltr"><br></div><div dir="ltr">As you might know, QGIS3 will get rid of the current (mainly) outdated context help dialogs. These were not really maintained for years, and hard to translate (a big piece of text, full of html tags, that you have to rework when a single letter changes).</div><div dir="ltr"><br></div><div dir="ltr">Now, Hitting the help button in a dialog should open:</div><div dir="ltr">- the neither fully up-to-date but heartily maintained official and online doc</div><div dir="ltr">- or a local zipped doc.</div><div dir="ltr">Specifications were brought to discussion in QEP 51 [0] and UIX repo [1]. Afaik only the online doc relation infrastructure has been implemented for the moment (at least it's the only one I had tested and once customized, it works pretty good though some limitations - see the needed improvements summary at [2] ).</div><div dir="ltr"><br></div><div dir="ltr">The next step is to link all help buttons to the proper section in the documentation.<br><div dir="ltr"><span style="font-family:sans-serif">Actually, I found
out there are a lot of dialogs (older as well as newly created) without a
proper help button so I began a list in the uix issue reports repository [3].</span><font face="sans-serif">
If you want to help add the missing button, please feel free to do it.
And please check the fixed items in the list to ease the track.</font></div><br></div><div dir="ltr">Going further and based on an initial work of Richard Duivenvoorde (Thanks!), I set up a list with most of the existing dialogs and panels in QGIS (around 200), with their corresponding section in doc (if exists), and whether there's already a help button, the file in which to add the doc link (needs completion) and if the relation is already set or not.<br>The rationale of this file has been mentioned at [4] but I'd like to add that imho this db could be used as references to keep up-to-date help "dialogs". We can imagine a kind of magic commands from you devs, that automatically do the matching between the two repositories based on this list and updating that list will fix links without a need to manually set it in each resource file. I don't know if that's possible but it could be nice i think.<br></div>What are left to do:<br><div>- Complete the list of resource files, in which the commands to open the help link is se, and find missing dialogs (I couldn't dig all dialogs)<br></div><div>- Add the help button (or icon) where appropriate<br></div><div>- Set the relation to documentation pages<br></div><div>- Keep the table up-to-date<br></div><div><br></div>Giving a look to the QGIS code, I found that some links are added in the .h while others are in the .cpp one, sometimes as private slots or public ones. Can't figure out why so to avoid losing time (I'm afraid I had spent enough) and for a better subsidiarity, I think it's better to have developers handle that part of the "job".<br><br><div dir="ltr"><div>The whole file is available as a collaborative Framadate Calc at
[5]. I didn't find the markdown of the wiki or issue reports easily maintainable. Sorry the interface is in French but icons should help and it's fully Open Source :) . However, if you want to move it to a place that would be more
linked with QGIS infrastructure, feel free.<br></div></div><div dir="ltr"><br></div><div>Hoping that will be useful to the Project...<br></div><div dir="ltr"><br></div><div dir="ltr">Regards,</div><div dir="ltr">Harrissou<br><br>[0] QEP 51- <a href="https://github.com/qgis/QGIS-Enhancement-Proposals/issues/51" target="_blank">https://github.com/qgis/QGIS-E<wbr>nhancement-Proposals/issues/51</a> <br>[1] UIX discussion <a href="https://github.com/qgis/qgis3_UIX_discussion/issues/15." target="_blank">https://github.com/qgis/qgis3_<wbr>UIX_discussion/issues/15</a></div><div dir="ltr"><div dir="ltr">[2] QGIS 3 doc wiki <a href="https://github.com/DelazJ/QGIS-Documentation/wiki/On-the-road-to-QGIS3#relation-between-qgis-docs-and-desktop" target="_blank">https://github.com/DelazJ/QGIS<wbr>-Documentation/wiki/On-the-roa<wbr>d-to-QGIS3#relation-between-<wbr>qgis-docs-and-desktop</a><br>[3] Some dialogs missing help button <span style="font-family:sans-serif"> </span><font face="sans-serif"><a href="https://github.com/qgis/qgis3_UIX_discussion/issues/33." target="_blank">https://github.com/qgis/qgis3_<wbr>UIX_discussion/issues/33</a></font><br>[4] <a href="https://github.com/qgis/QGIS/pull/4135" target="_blank">https://github.com/qgis/QGIS/p<wbr>ull/4135</a><br></div><div>[5] Find the Data - <a href="https://framacalc.org/4hipbz1q7t" target="_blank">https://framacalc.org/<wbr>4hipbz1q7t</a><br></div><div dir="ltr"><br></div></div>
</div>
</div>
</div>
</div>
</div></div><br></div>
</div></div><br></div>