[GRASS-dev] grass-doc: whatis parse errors in manpages

(cc grass-dev)

On Sun, Nov 8, 2015 at 4:44 PM, Sebastiaan Couwenberg
<sebastic@xs4all.nl> wrote:

This issue is still present in GRASS 7.0.1.

...

We need a lot more changes like r37865 [1] adding NAME sections to the
HTML documentation to fix all these whatis issues.

[1] https://trac.osgeo.org/grass/changeset/37865

A lot of these pages are auto-generated, so adding a "NAME" section is
now theoretically easy.

But before doing so, we need to understand how to deal with the 102
"topic_xxx.html" pages like e.g.

https://grass.osgeo.org/grass70/manuals/topic_sampling.html

In all those "NAME" does not really make sense. Likewise the 7
xxxintro.html pages like e.g.
https://grass.osgeo.org/grass70/manuals/imageryintro.html

Any ideas?

Markus

On Sun, Nov 8, 2015 at 11:51 AM, Markus Neteler <neteler@osgeo.org> wrote:

But before doing so, we need to understand how to deal with the 102
"topic_xxx.html" pages like e.g.

https://grass.osgeo.org/grass70/manuals/topic_sampling.html

In all those "NAME" does not really make sense. Likewise the 7
xxxintro.html pages like e.g.
https://grass.osgeo.org/grass70/wrongmanuals/imageryintro.html
<https://grass.osgeo.org/grass70/manuals/imageryintro.html&gt;

I agree that we should think it through.

r.li page mentioned above (I like to call this type module group) has
GRASS-custom meta comment (not what is in r37865):

<!-- meta page description: Landscape structure analysis package overview
-->
<h2>DESCRIPTION</h2>
...

This is turned into a heading when the complete page is generated.
Unfortunately, the heading is <h2> and the other headings are <h2> as well.
The results is thus semantically wrong and graphically ugly HTML (which is
worsen by using all uppercase in headings). I think this applies to wxGUI
pages too. *intro pages are better since the other headings are level 3:

<!-- meta page description: Image processing in GRASS GIS -->
<h3>Image processing in general</h3>

I think the NAME section doesn't make sense for topics, intros, some GUI
and some other pages perhaps including the module group pages like r.li. If
man et al. needs NAME and some special things than I think we should solve
it during compilation specifically for man pages.