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

GRASS GIS trac at osgeo.org
Tue Aug 23 06:50:06 PDT 2016


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

Comment (by wenzeslaus):

 Implement one or more from:

 * Single page HTML version of the module tree from the Modules tab in GUI
  * for browsing the modules
  * This should be something like
 source:grass/trunk/gui/wxpython/xml/toolboxes.xml in HTMl
  * likely requires #2142
 * Multiple pages HTML version of the module tree from the Modules tab in
 GUI
  * same as above but can be also combined with back-links from individual
 modules (last item)
  * anchors in the single version may work as well
 * Full list of modules with their position in menu/tree
  * for finding a module by description and then finding the module in
 menu/tree
  * see comment:7 and comment:8
 * Add tree position (or positions) to module documentation, e.g.:

 {{{
 NAME
     r.grow - Generates a raster map layer with contiguous areas grown by
 one cell.
 KEYWORDS
     raster, distance, proximity
     Raster → Raster buffers and distance → Grow by one cell
 SYNOPSIS
     r.grow
 }}}

 or

 {{{
     Raster → Raster buffers and distance → Grow by one cell
 NAME
     r.grow - Generates a raster map layer with contiguous areas grown by
 one cell.
 KEYWORDS
     raster, distance, proximity
 SYNOPSIS
     r.grow
 }}}

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



More information about the grass-dev mailing list