[GRASS-dev] [GRASS GIS] #645: link documentation to new GUI developments

[GRASS GIS]

#645: link documentation to new GUI developments
------------------------------------+---------------------------------------
 Reporter:  timmie                  |       Owner:  grass-dev@…              
     Type:  enhancement             |      Status:  new                      
 Priority:  minor                   |   Milestone:  7.0.0                    
Component:  Docs                    |     Version:  svn-trunk                
 Keywords:  wxGUI, toolboxes, menu  |    Platform:  All                      
      Cpu:  All                     |  
------------------------------------+---------------------------------------

Comment(by hamish):

 Replying to [comment:11 neteler]:
 > Would it be possible to parse the modules.xml file via a new
 > flag --menu-description which would output the related menu
 > entry in HTML code?

 fwiw, I'm not excited to make that part of the module parser, the GUI
 structure being present shouldn't be a prerequisite of successfully
 building a module. So it would have to at least fail gracefully. I guess
 it needs that anyway because a number of the helper modules aren't
 available from the GUI.

 > Then it could be put together at compile time as already with
 > header and main HTML help text.

 Yes, it would be nice to just inject it after the options description but
 before the g.module(description).html text as part of tools/mkhtml.py. I'd
 suggest to have it export in plain but parsable text, then the html
 writing code could replace ' | ' with ' → ' or whatever as needed on
 the fly.


 note the tools/module_synopsis.sh code needs some help since the wxgui
 layout and menudata.py changed and 'python menudata.py commands' no longer
 works:

 {{{
 #### fixme: no longer exists
 MDPY="$GISBASE/etc/wxpython/gui_modules/menudata.py"

 # python menudata.py commands
 # python menudata.py tree
 # python menudata.py strings
 python "$MDPY" commands | sed -e 's/ | /|/' -e 's/[ -].*|/|/' \
   | sort -u > "$TMP.menu_hierarchy"
 }}}

 what's the replacement script/functionality?

 (here it builds up a table of the menu locations for all modules in a
 first step, then instead of re-parsing the entire menu tree for each
 module, which would be slow for a full build, it just looks up the module
 name in the table.)


 Hamish

-- 
Ticket URL: <http://trac.osgeo.org/grass/ticket/645#comment:12>
GRASS GIS <http://grass.osgeo.org>