[Qgis-community-team] Manuals and help

[samuelmesa at gmail.com]

Paolo, recently I'm trying to explore the help of SAGA for Sextante, and
I've seen that you can extract the documentation from SAGA GIS through the
following command:

saga_cmd [-d], [--docs]   : create module documentation in current working
directory

Which you can get the following HTML files:

http://goo.gl/0WhTj

I have seen that these files could be located in the folder
/usr/share/qgis/python/plugins/sextante/saga/help/
(Linux), obviously must rename each html file by the name of the command of
saga.

However, I would suggest modifying the python file [1] to help organize
files by folder module and not the entire list of html files in a single
folder?.

Thank you,

Samuel Mesa.

[1]
https://github.com/qgis/Quantum-GIS/blob/master/python/plugins/sextante/saga/SagaAlgorithm.py
#L370


2013/7/10 Paolo Cavallini <cavallini at faunalia.it>

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> 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.
> - --
> Paolo Cavallini - Faunalia
> www.faunalia.eu
> Full contact details at www.faunalia.eu/pc
> Nuovi corsi QGIS e PostGIS: http://www.faunalia.it/calendario
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.12 (GNU/Linux)
> Comment: Using GnuPG with Icedove - http://www.enigmail.net/
>
> iEYEARECAAYFAlHdlt4ACgkQ/NedwLUzIr5nbwCfZm1Qh+7Ye35/d/U+5Z19tn/2
> +j0Anjr5z5QPWI5FoBNdH+uJINBZqDHO
> =mYpB
> -----END PGP SIGNATURE-----
> _______________________________________________
> Qgis-community-team mailing list
> Qgis-community-team at lists.osgeo.org
> http://lists.osgeo.org/mailman/listinfo/qgis-community-team
>



-- 
---
    .~.
   / v \
  //    \\
 /(      )\
   ^`~'^
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-community-team/attachments/20130710/6a45f585/attachment.html>