[Qgis-community-team] Manuals and help

[Victor Olaya]

Andreas

I discussed this already with Paolo. Basically, the thing is that the
SAGA community hasn't done any work documenting the algorithms in all
the time that SAGA has been around, so if we want to have this ready
one day, which is itself a very large amount of work, we should not
have anything that might make it more difficult.

Also, algorithms in SEXTANTE have been modified to make them more user
friendly, so the parameters are not exactly the same ones as in SAGA.
For instance, some algorithms ask for  coordinate values as separate
numbers, while in SEXTANTE I have grouped them in a extent parameter,
so it can be entered by just clicking and dragging on the QGIS canvas.
Other algorithms have several options, some of which are not available
in SEXTANTE baecause they do not make sense or do not integrate well.
Having those algorithms with a documentation that does not match what
the SEXTANTE user sees will make their usage more confusing.

But, for me, the main reason to do it on our own is just to make thing
easier, since, unfortunately, I do not think that doing it upstream
will have any benefit for us, while it can be less practical for
contributors from our side

Cheers
Victor

2013/7/10 Andreas Neumann <a.neumann at carto.net>:
> Hi,
>
> Isn't this primarily a SAGA issue and the help files should be
> contributed upstream to the SAGA project and not to the QGIS project? We
> could still reference them if they are available online.
>
> Andreas
>
> Am 10.07.2013 20:08, schrieb Anita Graser:
>> I'd be happy to help, no matter which format will be chosen.
>> Please post a guide about how to contribute once you've decided.
>>
>> Best wishes,
>> Anita
>>
>>
>> On Wed, Jul 10, 2013 at 7:16 PM, Paolo Cavallini <cavallini at faunalia.it>wrote:
>>
>> Hi all.
>> As you know, help is missing for most sextante modules, with the notable
>> exception of
>> GRASS. I'm about to start searching for people interested in contributing
>> help pages.
>> Before doing that, I would like to clarify one point, that could
>> potentially cause a
>> lot of duplication and some frustration.
>> I think the help pages for the modules are also interesting for the
>> manual, so I
>> guess we should decide whether to merge the two (manual and module help)
>> from the
>> beginning, an make one of the two take the pages from the other.
>> I know the style could be different between the two, but I do not think it
>> is
>> realistic thinking someone will write (and maintain) documentation on
>> hundreds of
>> modules, in two different styles.
>> The pages are here:
>> https://github.com/volaya/SEXTANTE-Help
>> What is opinion? The issue is important, as IMHO this is a stumbling block
>> preventing
>> the start of documentation writing.
>> Thanks in advance.
>>> _______________________________________________
>>> Qgis-community-team mailing list
>>> Qgis-community-team at lists.osgeo.org
>>> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>>>
>>
>>
>>
>> _______________________________________________
>> Qgis-community-team mailing list
>> Qgis-community-team at lists.osgeo.org
>> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>>
>
> _______________________________________________
> Qgis-community-team mailing list
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team