[GRASS-user] grass 6.3 module list in PDF

Moritz Lennert mlennert at club.worldonline.be
Wed Nov 8 07:40:03 EST 2006


Hamish wrote:
> Hi,
> 
> Richard Gagne gave me the idea to rebuild something I found useful from
> GRASS 5, an easy to read synopsis of modules. This is basically a PDF
> version of full_index.html.
> 
> It's in CVS now, and this link will become active sometime in the next
> 24 hours:
>   http://grass.itc.it/gdp/grassmanuals/grass63_module_list.pdf
> 
> With the speed of GRASS's development, I imagine this will be out of
> date by then, and it will much be better to write a
> tools/build_latex_index.sh script or add the functionality into the
> tools/build_html_index.sh script.
> 
> unanswered style question: do module descriptions get a trailing "."?
> 
> 
> the GRASS 5 manuals used to build themselves into PDF form,
>   http://grass.itc.it/gdp/grassmanuals/
> 
> maybe we could set up a script to do this for GRASS 6? (chances are good
> that Markus already has & I've missed it :) It could be a nice PDF
> auto-generated latex book, chapters by type, clickable index, etc.

Could we also add the information on where to find these modules in the 
gis.m menu ? Maybe just the output of a simple script would be enough, 
such as


grep G_msg gui/tcltk/menus/menu.tcl | awk -F"\"" 
'{if(substr($2,1,1)=="&") print $2;  else {if($4=="") print "\t"$2; else 
print "\t""\t"$2 "=" $4}}'


This shows the menu structure and the command behind each menu entry. 
Ideally, this should be turned around so that for each command listed in 
your PDF it shows the path in the menu. Something like

  grep G_msg gui/tcltk/menus/menu.tcl | awk -F"\"" 
'{if(substr($2,1,1)=="&") {gsub("&","",$2);top=$2}  else {if($4=="") 
second=$2; else print $4": "top"->"second"->"$2}}'

Which works for menus which only have 3 levels (i.e. r.surf.fractal: 
Raster->Generate surfaces->Generate fractal surface) but not for those 
which have 4 levels (i.e. r.in.gdal: File->Import->Raster map->Multiple 
formats using GDAL becomes r.in.gdal: File->Raster map->Multiple formats 
using GDAL). I don't have the time to solve this now, but it shouldn't 
be too hard.

This would help those using documentation explaining command line 
operations find the commands they are looking for.

Moritz




More information about the grass-user mailing list