[GRASS-dev] Re: [GRASS GIS] #612: g.html2man: parsing leads to man page errors

[GRASS GIS]

#612: g.html2man: parsing leads to man page errors
--------------------------+-------------------------------------------------
  Reporter:  hamish       |       Owner:  grass-dev at lists.osgeo.org
      Type:  defect       |      Status:  new                      
  Priority:  normal       |   Milestone:  6.5.0                    
 Component:  Docs         |     Version:  6.4.0 RCs                
Resolution:               |    Keywords:  g.html2man               
  Platform:  Unspecified  |         Cpu:  All                      
--------------------------+-------------------------------------------------
Comment (by hamish):

 Replying to [comment:6 glynn]:
 > The changes are meaningless;

 a few qualifiers on that are appropriate: a) currently; b) just for the
 python version in gr7. (the perl version in all Gr versions now knows
 about it)

 > g.html2man.py discards all comments.

 the solution I used in the perl version was to check for that meta tag
 before the comment stripping code.

 > To get a suitable whatis entry, the HTML file needs to include
 > a {{{<h2>NAME</h2>}}} section containing the module name
 > followed by a dash then the description. This is added
 > automatically by --html-description, but non-module pages will
 > need to have it added manually.

 yeah, I look at doing that first. But the <H2>NAME really wasn't
 appropriate for the intro and driver custom HTML pages I looked at and so
 I went with the meta-tag solution.

 I couldn't see how to make that work with the python version (does
 HTMLParser.py strip out the comments before we can get our hands on
 them?), and so I left it for now.


 Hamish

-- 
Ticket URL: <https://trac.osgeo.org/grass/ticket/612#comment:7>
GRASS GIS <http://grass.osgeo.org>