[Qgis-community-team] Help and manual

[Paolo Cavallini]

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

Il 11/07/2013 13:14, Paolo Cavallini ha scritto:

>>> (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.

Hi all,
I'd be keen to start this job. I'd like to set it up properly before starting, to
avoid frustrating the documenters. I think the above could be implemented easily by
linking/copying files in both places (manual and help), so if they are different each
one will appear in the right place, if there is only one version it will be used by both.
Agreed? If so, could we have an appropriate template, we can start?
Thanks.
- -- 
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/

iEYEARECAAYFAlHjxkAACgkQ/NedwLUzIr7QQACghfiQw/vKJBHfpxFRmGU5JLRZ
3RAAoJAZs869OMnnndPY2ncnZeQWgOL0
=XXFV
-----END PGP SIGNATURE-----