[Qgis-community-team] Processing help

[Matteo Ghetta]

Hi Alex,
thanks for clarifying, I missed some information.. :)

I have just two small questions:
* as you said some QGIS core algorithms are already documented, for example
the *Help* tab of **reproject layer** is full. The help files of these
algorithms are here [0], right? Can I copy/paste these help files to the
processing_algs folder you have created? So we can begin to do some test..
* if I want to add an image to the algorithm description, I cannot
understand where should I put it. Maybe here [1]? If so, I can add two
lines in the documentation guidelines in order to explain this thing. BTW,
png format is preferable right?

Thanks again and sorry for the noise.. :)

Matteo



[0]
https://github.com/qgis/QGIS/tree/master/python/plugins/processing/algs/qgis/help
[1]
https://github.com/qgis/QGIS-Documentation/tree/master/resources/en/docs/user_manual/processing_algs/taudem

2014-11-27 9:48 GMT+01:00 Alexander Bruy <alexander.bruy at gmail.com>:

> Hi Matteo,
>
> 2014-11-27 10:27 GMT+02:00 Matteo Ghetta <matteo.ghetta at gmail.com>:
> > as pointed out by Paolo, some help files of SAGA are already documented.
> > For example:
> >
> >
> https://github.com/qgis/QGIS/blob/master/python/plugins/processing/algs/saga/help/shapesbuffer.rst
> >
> > are there any chances to merge these algorithm help files to the new
> > "branch" you have created or have we to copy and paste them?
>
> please read my previous emails carefully, all your questions already
> answered :-)
>
> 2014-11-26 19:06 GMT+02:00 Alexander Bruy <alexander.bruy at gmail.com>:
> > 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)
>
> BTW, personally I'm not happy with coverage of this help files, they are
> too
> simple and does not give reader full overview of algoroithm and
> parameters/outputs.
>
> > Another thing: I have compiled the user manual and now it has more than
> 700
> > pages because of all the algorithms. I think we have to avoid this
> section
> > for the normal compilation of the manual and treat it like a new resource
> > (like Introduction to GIS, Training Manual, PyQGIS Cookbook..).
>
> We already discussed this in previous emails
>
> 2014-11-21 10:59 GMT+02:00 Richard Duivenvoorde <richard at duif.net>:
> > And if it is too big for print, we could add some Makefile rules to
> > shrink it down for certain use-cases. It is just adding them to the
> > 'exclude_patterns'-list in the conf file.
>
>
> --
> Alexander Bruy
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20141127/5220e52c/attachment.html>