[GRASS-dev] TOC in HTML manual pages
Hi, I'm excited about the new TOC in HTML manual pages. There are some styling issues (bullet for every second item), and looking to the HTML code, the generator is creating both table and ul which is not good. ul should be enough. http://grass.osgeo.org/grass71/manuals/r.mapcalc.html Anyway, I've tried different approach and here is my prototype: https://googledrive.com/host/0B_7Sygt2HTPDamFPOEZpU0h1ZG8/r.mapcalc.html The TOC is generated by JavaScript, so it is available only when JS is available (and thus probably also CSS is available). The header contains empty div into which TOC is generated. The other difference is the CSS, we can compare what is better. The not so wide page content as it is currently in trunk actually quite good. However, CSS and HTML is not (yet) optimized for wxHtmlWindow. You have to hover over TOC to make the TOC itself visible. There is also a warning box with a link to a another versions of documentation (e.g. from trunk to release). And also title of the page. But this is unrelated to TOC. Vaclav ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in HTML manual pages
Hi, 2014-04-19 17:45 GMT+02:00 Vaclav Petras wenzesl...@gmail.com: Anyway, I've tried different approach and here is my prototype: https://googledrive.com/host/0B_7Sygt2HTPDamFPOEZpU0h1ZG8/r.mapcalc.html I like your changes, two small notes: * GRASS GIS 7 label is too big ;-) * link to GRASS 6 could point directly to the manual page of given module Martin ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in HTML manual pages
Vaclav Petras wrote: I'm excited about the new TOC in HTML manual pages. There are some styling issues (bullet for every second item), and looking to the HTML code, the generator is creating both table and ul which is not good. ul should be enough. A more significant issue is that it overlooks the fact that the HTML files are the source files for the Unix (nroff) manual pages, where a ToC is just pointless junk. Fixed in r59825. http://grass.osgeo.org/grass71/manuals/r.mapcalc.html Anyway, I've tried different approach and here is my prototype: Please don't end up breaking the Unix manual pages (again) in the process. Whatever you do, ensure that the generated HTML is actually conformant (to HTML 4 transitional); g.html2man isn't fault-tolerant. -- Glynn Clements gl...@gclements.plus.com ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
[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 ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in the manual
Hi Martin, On Fri, Apr 11, 2014 at 10:38 AM, Martin Landa landa.mar...@gmail.comwrote: 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-...@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. ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in the manual
Hi, 2014-04-11 10:44 GMT+02:00 Margherita Di Leo dileomargher...@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 ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in the manual
Hi, 2014-04-11 10:38 GMT+02:00 Martin Landa landa.mar...@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
Re: [GRASS-dev] TOC in the manual
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.mar...@gmail.com wrote: Hi, 2014-04-11 10:38 GMT+02:00 Martin Landa landa.mar...@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 -- ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in the manual
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 yche...@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 On 11 April 2014 14:33, Martin Landa landa.mar...@gmail.com wrote: Hi, 2014-04-11 10:38 GMT+02:00 Martin Landa landa.mar...@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 -- ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
Re: [GRASS-dev] TOC in the manual
+1 On 12 April 2014 03:57, Anna Petrášová kratocha...@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 yche...@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 On 11 April 2014 14:33, Martin Landa landa.mar...@gmail.com wrote: Hi, 2014-04-11 10:38 GMT+02:00 Martin Landa landa.mar...@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 -- ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev -- ___ grass-dev mailing list grass-dev@lists.osgeo.org http://lists.osgeo.org/mailman/listinfo/grass-dev
