[Qgis-community-team] Help and manual

[Paolo Cavallini]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Il 11/07/2013 12:06, Otto Dassau ha scritto:

>> agreed; this would hold true also for all Help pages. 
>> I think a more uniform approach would be preferable.
> 
> good idea. It could e.g also be an approach for the core plugins.

yes

>> (and the manual). of course, a mixed approach is also good, pointing to
>> manual pages where appropriate, and to specific Help pages when available.
> 
> ok, this might be a reason to integrate the help pages with the module
> itself, as done in GRASS, so changes to the module can directly and easily be
> applied to the help page by the developer as well. Is that what you mean and
> would suggest?

I'm not sure I'm following you. What I mean is:
* if there are both a manpage and an help entry, show the second in qgis, the first
in the manual
* if there is no help entry, show the manpage
* if there is only the help entry, use this also for the manual.

> I would love to make the work of our documenters easier and I think this
> process could be improved, if developers get a bit more involved providing
> short but clear notes about the work they did. This is not very popular for
> many devs, I know, but it would improve the manual a lot, if we could
> integrate this fact into the documentation process.

Right; it will be far easier for a documenter to expand even very short notes than
starting from 0.

All the best.
- -- 
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/

iEYEARECAAYFAlHek30ACgkQ/NedwLUzIr6X3wCfSrXsGrLj+EKLzhFYiPo3MCLF
T8YAoLUjhWPOdBhQeSa5XnYRi3okvrdh
=oFGi
-----END PGP SIGNATURE-----