[GRASS-dev] TOC in the manual

Hi all,

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.

Martin

[1] http://grass.osgeo.org/grass71/manuals/v.build.html

--
Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa

Hi Martin,

···

On Fri, Apr 11, 2014 at 10:38 AM, Martin Landa <landa.martin@gmail.com> wrote:

Hi all,

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

Tel. +39 0332 78 3600
margherita.di-leo@jrc.ec.europa.eu

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.

Hi,

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

Hi,

2014-04-11 10:38 GMT+02:00 Martin Landa <landa.martin@gmail.com>:

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.

the question is whether to hide manual tab and just to provide button
which opens manual in the web browser. Martin

--
Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa

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.

+1 for button to external browser

···

On 11 April 2014 14:33, Martin Landa <landa.martin@gmail.com> wrote:

Hi,

2014-04-11 10:38 GMT+02:00 Martin Landa <landa.martin@gmail.com>:

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.

the question is whether to hide manual tab and just to provide button
which opens manual in the web browser. Martin


Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa


grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

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.

+1 for button to external browser


grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

On 11 April 2014 14:33, Martin Landa <landa.martin@gmail.com> wrote:

Hi,

2014-04-11 10:38 GMT+02:00 Martin Landa <landa.martin@gmail.com>:

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.

the question is whether to hide manual tab and just to provide button
which opens manual in the web browser. Martin


Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa


grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

+1

···

On 12 April 2014 03:57, Anna Petrášová <kratochanna@gmail.com> wrote:

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.

+1 for button to external browser


grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev

On 11 April 2014 14:33, Martin Landa <landa.martin@gmail.com> wrote:

Hi,

2014-04-11 10:38 GMT+02:00 Martin Landa <landa.martin@gmail.com>:

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.

the question is whether to hide manual tab and just to provide button
which opens manual in the web browser. Martin


Martin Landa * http://geo.fsv.cvut.cz/gwiki/Landa


grass-dev mailing list
grass-dev@lists.osgeo.org
http://lists.osgeo.org/mailman/listinfo/grass-dev