in r59673 I introduced simple mechanism to add TOC to the manual pages. It needs
some testing, anyway it seems to work. TOC is now fixed and width of
body part is 80%, see eg. [1]. Since wxPython widget doesn't support
most of css, it's shown before DESCRIPTION and not as fixed.
in r59673 I introduced simple mechanism to add TOC to the manual pages. It needs
some testing, anyway it seems to work. TOC is now fixed and width of
body part is 80%, see eg. [1]. Since wxPython widget doesn’t support
most of css, it’s shown before DESCRIPTION and not as fixed.
Thank you! Looks very fancy!
Talking about documentation, since GRASS has strong ties with academia, what do you think about adding also a section “cite as” for the relevant modules?
Thank you,
Madi
–
Best regards,
Dr. Margherita DI LEO
Scientific / technical project officer
European Commission - DG JRC
Institute for Environment and Sustainability (IES)
Via Fermi, 2749
I-21027 Ispra (VA) - Italy - TP 261
Disclaimer: The views expressed are purely those of the writer and may not in any circumstance be regarded as stating an official position of the European Commission.
2014-04-11 10:44 GMT+02:00 Margherita Di Leo <dileomargherita@gmail.com>:
Talking about documentation, since GRASS has strong ties with academia, what
do you think about adding also a section "cite as" for the relevant modules?
why not, it could generated automatically by mkhtml.py. Martin
Did not have an opinion fixed, so went back to work, opened a module, pressed on the manual tab and did have to wait a bit because of rendering… If it was to open in a default web browser, I could have continued looking around the module.
Note, that on Windows and on Ubuntu with wxPython 3, the manual page in the tab is loaded immediately. I believe we should keep the manual in the tab, I think people are more likely to look at the manual there than pressing Help button. Personally I try to avoid pressing Help button in any application, it usually takes a lot of time to start browser and load it. WxPython 3 has some new widget for websites so eventually, it could replace the widget we use now.
Anna
···
On Fri, Apr 11, 2014 at 6:49 AM, Yann Chemin <ychemin@gmail.com> wrote:
Did not have an opinion fixed, so went back to work, opened a module, pressed on the manual tab and did have to wait a bit because of rendering… If it was to open in a default web browser, I could have continued looking around the module.
Note, that on Windows and on Ubuntu with wxPython 3, the manual page in the tab is loaded immediately. I believe we should keep the manual in the tab, I think people are more likely to look at the manual there than pressing Help button. Personally I try to avoid pressing Help button in any application, it usually takes a lot of time to start browser and load it. WxPython 3 has some new widget for websites so eventually, it could replace the widget we use now.
Anna
–
On Fri, Apr 11, 2014 at 6:49 AM, Yann Chemin <ychemin@gmail.com> wrote:
Did not have an opinion fixed, so went back to work, opened a module, pressed on the manual tab and did have to wait a bit because of rendering… If it was to open in a default web browser, I could have continued looking around the module.