[Qgis-developer] New QGIS Generic Help

[Matthias Kuhn]

Hi Matteo,

Yes, this is the idea as far as I understand.
What's missing is the concept.

Here a proposal:

 * Add a new helpTag property to the processing GeoAlgorithm class

 * Set the help tag to something like
    processing_algs/saga/grid_analysis/aggregation-index

 * Within our documentation server
   * Create pages where we have extra docs for algorithms
   * Add a rewrite rule (or some other script logic) to forward the
     browser to the upstream documentation, where no override exists.

What would also be nice if someone with experience and connections could
check with saga, grass, etc. how collaboration could work, especially
also w.r.t. to translation of algorithm documentation.

Matthias

On 01/13/2017 10:40 AM, matteo wrote:
> Hi devs,
> 
> I saw the PR to improve/start the QGIS Generic Help system [0], thanks Alex!
> 
> I was just thinking a way to take advantages of this new method for
> improving the help files of Processing, especially for SAGA.
> 
> I know I'm boring, but IMHO having super algorithm without any guide on
> the input, output and parameter is barely useless (except if the user
> knows already the algorithm).
> 
> In December I pointed out a similar question [1], could we make some
> default link to the SAGA url(s) and algorithms?
> 
> Just my 2 cent
> 
> Cheers
> 
> Matteo
> 
> 
> [0] https://github.com/qgis/QGIS/pull/3911
> [1]
> https://lists.osgeo.org/pipermail/qgis-developer/2016-December/046290.html
> _______________________________________________
> Qgis-developer mailing list
> Qgis-developer at lists.osgeo.org
> List info: http://lists.osgeo.org/mailman/listinfo/qgis-developer
> Unsubscribe: http://lists.osgeo.org/mailman/listinfo/qgis-developer
>