[Qgis-developer] About Processing documentation

[Ricardo Garcia Silva]

In my opinion some documentation on how to write Processing plugins is 
needed.

Victor mentioned in the previous thread that there is already some 
documentation on the QGIS user guide that is useful for developing plugins 
(which I assume to be this[1]). The mentioned docs  are helpful for writing 
Python scripts. While indeed being very useful, I think that they cater to 
a different use case. It seems to me that this is more of an 'advanced 
user' type of feature than a 'developer' one. With this in mind, it makes 
sense to me that these docs are currently in the user guide.

What I think is lacking is some documentation on how to write a proper 
plugin that can be distributed via plugin manager. Some stuff that seems 
relevant and lacking:

* Describing the overall architecture of the Processing framework. Perhaps 
a brief description of the main classes or some high level diagram. Also 
some API docs, akin to the QGIS C++ API, perhaps with one or two examples, 
where appropriate;

* How to organize things in the toolbox and how do the concepts of the 
algorithm provider and the grouping of algs in the toolbox are related;

* How to use the AlgorithmProvider, GeoAlgorithm, Parameter and Output 
classes;

* How to work with the settings panel, logging facilities, progress 
indicators and other extra goodies that Processing already has;

* Throw in an example of how to expose a regular python plugin (I mean one 
that manages its own GUI) through Processing in there as well, in order to 
help refactoring the current plugins that could benefit from tighter 
integration with the rest of QGIS.

I'm also available for helping out with this, if necessary/needed.

Best regards

[1] - http://docs.qgis.org/2.14/en/docs/user_manual/processing/scripts.html

Em terça-feira, 13 de Setembro de 2016 06:56:16 WEST, Paolo Cavallini 
<cavallini at faunalia.it> escreveu:
> Il 13/09/2016 07:51, Victor Olaya ha scritto:
>
>> There was some discussion about the Processing documentation in
>> another thread, mainly about the one targeted at developers.
>> 
>> I was thinking about spending some time improving/updating the
>> documentation, both for users and devs, and most likely Alex Neto will
>> have some time as well to help me on that, organizing stuff,
>> completing what is missing and doing a bit of cleaning. Since this is
>> a good oportunity to move forward in the Processing documentation, I
>> would like to ask you for you ideas and comments, so we can focus on
>> what is more important or urgent.
>
> Thanks Victor, a much welcome offer. IMHO an important thing is to make
> it easier for users to add their content: many algs are very
> specialized, and allowing someone expert in that field will greatly
> speed up the building of a complete documentation.
> IMHO it is also important to keep on reusing existing docs, available at
> least for GRASS, GDAL, and OTB. This will result in some heterogeneity,
> but is better and more sustainable in the long term than redoing everything.
> I'm available for help if necessary.
> All the best.


-- 
Enviado do Dekko através do meu dispositivo Ubuntu.