[QGIS-Developer] New Processing Help System summary

[Tim Sutton]

Thanks so much for the summary Matteo, it is really nice to see a summary of the current status list this!

I hope soon someone van figure out how to document the SAGA processing tools!

Regards

Tim

> On 18 Feb 2018, at 16:30, matteo <matteo.ghetta at gmail.com> wrote:
> 
> Hi all,
> 
> I'm writing here a brief summary of the current situation of the
> Processing Help system.
> 
> Currently all the QGIS algorithms have been described and all the PR in
> the doc repository have been merged (kudos to Harrissou for all the
> reviews!).
> 
> Right now the Help button of each Processing dialog will open the
> related page of the algorithm, BUT:
> 
> * if the name of the algorithm is made by only ONE word (e.g. clip,
> intersection...), the help button will open the browser to also the
> correct section (that is, the user will see directly th description of
> the related algorithm)
> * if the name of the algorithm has >1 words (e.g. split polygon with
> lines, lines to polygon, ecc.) the Help button will open the correct
> page (so the algorithm GROUP) but is not able to go to the correct
> algorithm anchor. This is because sphinx converts "split with lines" in
> "split-with-lines" while QGIS system will always cast the words
> "split-with-lines" in "splitwithlines". Not a big deal, but IMHO a pity.
> We are really too close to the solution.
> 
> So Processing Help system right now consists i:
> 
> * QGIS algs -> documented
> * GDAL algs -> documented
> * GRASS -> documented (own docs)
> * Orfeo -> documented (own docs)
> * SAGA -> nothing documented
> 
> Thanks to QGIS Grants to provide this chance to give a big improvement
> to the Processing framework even if not in a coding way.
> 
> Cheers
> 
> Matteo
> 
> _______________________________________________
> 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

—







Tim Sutton

Co-founder: Kartoza
Project chair: QGIS.org

Visit http://kartoza.com <http://kartoza.com/> to find out about open source:

Desktop GIS programming services
Geospatial web development
GIS Training
Consulting Services

Skype: timlinux
IRC: timlinux on #qgis at freenode.net

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180218/84d980e1/attachment-0001.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: KartozaNewLogoThumbnail.jpg
Type: image/jpeg
Size: 6122 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180218/84d980e1/attachment-0001.jpg>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: Message signed with OpenPGP
URL: <http://lists.osgeo.org/pipermail/qgis-developer/attachments/20180218/84d980e1/attachment-0001.sig>