[Qgis-community-team] Processing help

[Alexander Bruy]

Hi again,

existing information from old help files for QGIS and SAGA algorithms
also ported to User Guide and already available for preview at QGIS
site. Let me know if some algs still not ported, maybe I just miss this
help file.

Note that coverage and detailisation of this help files are much-much lower
than GRASS or TauDEM ones so improving and extending more than welcome.
Guidelines for editing also available [1]. This is my view, if necessary we can
adjust them.

Proofreading, suggestions and comments are welcome.

[1] https://github.com/qgis/QGIS-Documentation/tree/master/source/docs/documentation_guidelines#documenting-processing-alorithms

2014-11-26 19:06 GMT+02:00 Alexander Bruy <alexander.bruy at gmail.com>:
> Hi all,
>
> I just merged my work into master branch of the QGIS-Documentation repository.
> This includes help files templates for almost all core Processing
> algorithms (need
> to investigate situation with LAStools, seems some algs only available under
> Windows).
>
> Also I create small guidelines for authors [0], add little description
> for each algorithm
> provider and port old TauDEM help files to new format. Proofreading, suggestions
> and comments are welcome.
>
> My next step is to go over existing old help files and move any
> valuable information
> to documentation. If anyone wants to join — please do it, but note
> that help files
> format now a bit different from old one due to changes in Processing
> code, so some
> manual work is required (nothing special just copy-paste)
>
> I will try to add support for this help files in Processing this week,
> so we can run some
> tests.
>
> [0] https://github.com/qgis/QGIS-Documentation/tree/master/source/docs/documentation_guidelines#documenting-processing-alorithms
>
> 2014-11-24 20:22 GMT+02:00 Paolo Cavallini <cavallini at faunalia.it>:
>> Il 24/11/2014 18:27, Alexander Bruy ha scritto:
>>> When my branch will be merged, I will update Processing code so it
>>> will look for help
>>> in User Guide. Then we can safely remove several remaining help files
>>> for QGIS algs
>>> from sources.
>>
>> Thanks Alex for clarifying.
>> Please note that we also have a few tens of descriptions for saga algs, as a result
>> of volunteer efforts.
>> All the best.
>> --
>> Paolo Cavallini - www.faunalia.eu
>> Corsi QGIS e PostGIS: http://www.faunalia.eu/training.html
>
>
>
> --
> Alexander Bruy



-- 
Alexander Bruy