#!/bin/sh # generates HTML man pages docs/html/index.html # (c) The GRASS Development Team, and Markus Neteler, 2003, 2004, 2005, 2006, 2009 ## TODO: better fix this in include/Make/Html.make, see RT bug #5361 # exclude following list of modules from help index: EXCLUDEMODS="\ d.font.freetype \ d.paint.labels \ d.text.freetype \ i.ask \ i.find \ p.out.vrml \ i.photo.elev \ i.photo.target \ r.cats \ r.watershed.ram \ r.watershed.seg \ v.topo.check \ helptext.html \ gis.m \ wxGUI.*" # these modules don't use G_parser() check_for_desc_override() { case "$BASENAME" in g.parser) SHORTDESC="Provides automated parser, GUI, and help support for GRASS scipts." ;; r.mapcalc) SHORTDESC="Raster map calculator." ;; r3.mapcalc) SHORTDESC="3D raster map calculator." ;; r.li.daemon) SHORTDESC="Support module for r.li landscape index calculations." ;; esac } ############# nothing to configure below ############ # regex-proof module skip list EXCLUDEHTML="`echo "$EXCLUDEMODS" | tr ' ' '|' | sed -e 's+\.+\\\\.+g' -e 's+|+\\\\|+g'`" #fetch the ARCH for store the files: ARCH="`cat ../include/Make/Platform.make | grep '^ARCH' | sed 's+ ++g' | cut -d'=' -f2`" GEMDIR="../gem" HTMLDIR="../dist.$ARCH/docs/html" GRASSVERSION=`cut -d' ' -f1 ../dist.$ARCH/etc/VERSIONNUMBER` GRASS_MMVER=`cut -d . -f 1-2 ../dist.$ARCH/etc/VERSIONNUMBER` MACOSX=`echo $ARCH | grep -i darwin` write_html_header() { # $1: filename # $2: page title # $3: is it main index echo " $2 " > "$1" if [ "$3" ] && [ "$MACOSX" ] ; then echo " " >> "$1" fi echo " \"GRASS

GRASS GIS $GRASSVERSION Reference Manual

Geographic Resources Analysis Support System, commonly referred to as GRASS, is a Geographic Information System (GIS) used for geospatial data management and analysis, image processing, graphics/maps production, spatial modeling, and visualization. GRASS is currently used in academic and commercial settings around the world, as well as by many governmental agencies and environmental consulting companies.

This reference manual details the use of modules distributed with Geographic Resources Analysis Support System (GRASS), an open source (GNU GPL'ed), image processing and geographic information system (GIS).

" >> "$1" } write_html_cmd_overview() { BOXCOLOR="#e1ecd0" echo "

 Quick Introduction

 Display/Graphical User Interfaces

  • wxGUI wxPython-based GUI frontend
  • gis.m and d.m TCL/TK-based GUI frontend
  • nviz 3D visualization and animation tool
  • xganim tool for animating a raster map series

 Raster and voxel processing

 Image processing

 Vector processing

 Database

 General

 Miscellaneous

 Variables

 Printing
" >> "$1" } write_html_footer() { # $1: filename # $2: help index url echo "

Help Index | Full Index
© 2003-2011 GRASS Development Team

" >> "$1" } expand_module_class_name() { # $1: module class if [ "$1" = "d" ] ; then echo "display" elif [ "$1" = "db" ] ; then echo "database" elif [ "$1" = "g" ] ; then echo "general" elif [ "$1" = "i" ] ; then echo "imagery" elif [ "$1" = "m" ] ; then echo "misc" elif [ "$1" = "ps" ] ; then echo "postscript" elif [ "$1" = "p" ] ; then echo "paint" elif [ "$1" = "r" ] ; then echo "raster" elif [ "$1" = "r3" ] ; then echo "raster3D" elif [ "$1" = "s" ] ; then echo "sites" elif [ "$1" = "v" ] ; then echo "vector" else echo "$1" fi } #are we in the tools/ dir? ls build_html_index.sh 2> /dev/null if [ $? -eq 1 ] ; then echo "ERROR: this script must be run from the tools/ directory" exit 1 fi FULLINDEX=full_index.html ################ #copy over CSS: cp -f grassdocs.css $HTMLDIR/ mkdir -p $HTMLDIR/nviz/ cp -f grassdocs.css $HTMLDIR/nviz/ chmod a+r $HTMLDIR/grassdocs.css $HTMLDIR/nviz/grassdocs.css #copy over GRASS logo: cp -f grass_logo.png $HTMLDIR/ cp -f grass_logo.png $HTMLDIR/nviz/ chmod a+r $HTMLDIR/grass_logo.png $HTMLDIR/nviz/grass_logo.png if [ "$MACOSX" ] ; then cp -f grass_icon.png $HTMLDIR/ chmod a+r $HTMLDIR/grass_icon.png fi #copy over GEM docs: mkdir -p $HTMLDIR/gem cp -f $GEMDIR/docs/GEM-Manual/*.html $HTMLDIR/gem/ cp -f $GEMDIR/docs/GEM-Manual/img* $HTMLDIR/gem/ chmod a+r $HTMLDIR/gem/*.html $HTMLDIR/gem/img* #process all HTML pages: cd $HTMLDIR #get list of available GRASS modules: CMDLIST=`ls -1 *.*.html | grep -v "$FULLINDEX" | grep -v index.html | \ grep -v gis.m.html | grep -v "\($EXCLUDEHTML\)" | cut -d'.' -f1 | sort -u | \ grep -v photo` CMDLISTNO=`echo $CMDLIST | wc -w | awk '{print $1}'` #write main index: echo "Generating HTML manual pages index (help system)..." write_html_header "$FULLINDEX" "GRASS GIS $GRASSVERSION Reference Manual: Full index" echo "Go back to help overview
" >> "$FULLINDEX" echo "

Full command index:

" >> "$FULLINDEX" #generate main index of all modules: echo "[ " >> "$FULLINDEX" k=0 for i in $CMDLIST do k=`expr $k + 1` echo -n "$i.*" >> "$FULLINDEX" if [ $k -lt $CMDLISTNO ] ; then echo -n " | " >> "$FULLINDEX" fi done echo " ]

" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "" >> "$FULLINDEX" echo "
  d.* display commands
  db.* database commands
  g.* general commands
  i.* imagery commands
  m.* miscellaneous commands
  ps.* postscript commands
  r.* raster commands
  r3.* raster3D commands
  v.* vector commands
  gis.m GUI frontend to GIS menus and display
  nviz visualization suite
  wxGUI wxPython-based GUI frontend
  xganim raster map slideshow
" >> "$FULLINDEX" ########## #for all module groups: for i in $CMDLIST do echo "" >> "$FULLINDEX" echo "

$i.* commands:

" >> "$FULLINDEX" echo "" >> "$FULLINDEX" #for all modules: for i in `ls -1 $i.*.html | grep -v "\($EXCLUDEHTML\)"` do BASENAME=`basename $i .html` SHORTDESC="`cat $i | awk '/NAME/,/SYNOPSIS/' | grep '' | cut -d'-' -f2- | sed 's+^ ++g' | grep -vi 'SYNOPSIS' | head -n 1`" check_for_desc_override echo "" >> "$FULLINDEX" done echo "
$BASENAME $SHORTDESC
" >> "$FULLINDEX" done write_html_footer "$FULLINDEX" index.html # done full index #next write separate module pages: #for all module groups: for k in $CMDLIST do MODCLASS=`expand_module_class_name $k` FILENAME=$MODCLASS.html MODCLASSlowcase=`echo $MODCLASS | tr '[:upper:]' '[:lower:]'` write_html_header "$FILENAME" "GRASS GIS $GRASSVERSION Reference Manual: $MODCLASS" # a few pages do not have the meta page: echo "Go to ${MODCLASS} introduction

" | grep -v 'generalintro.html\|miscintro.html\|postscriptintro.html' >> "$FILENAME" echo "Go back to help overview


" >> "$FILENAME" echo "$MODCLASS commands:" >> "$FILENAME" echo "" >> "$FILENAME" #for all modules: for k in `ls -1 $k.*.html | grep -v "\($EXCLUDEHTML\)"` do BASENAME=`basename $k .html` SHORTDESC="`cat $k | awk '/NAME/,/SYNOPSIS/' | grep '' | cut -d'-' -f2- | sed 's+^ ++g' | grep -vi 'SYNOPSIS' | head -n 1`" check_for_desc_override echo "" >> "$FILENAME" done echo "
$BASENAME $SHORTDESC
" >> "$FILENAME" write_html_footer "$FILENAME" index.html done #next write main page: FILENAME=index.html write_html_header "$FILENAME" "GRASS GIS $GRASSVERSION Reference Manual" 1 write_html_cmd_overview "$FILENAME" #insert a special comment so that GEM will know where to merge docs of extensions echo >> "$FILENAME" echo "" >> "$FILENAME" echo >> "$FILENAME" ############# write_html_footer "$FILENAME" index.html ############# echo "Generated HTML docs in $HTMLDIR/index.html" echo "----------------------------------------------------------------------" echo "Following modules are missing the 'description.html' file in src code:" for i in `find . -name "*.*.html" | sort | grep -v "$FULLINDEX" | grep -v 'index.html' | grep -v "$EXCLUDEHTML"` do if grep 'DESCRIPTION' $i >/dev/null 2>&1 ; then : else echo `echo $i | sed 's?./??' | sed 's/.html//'` fi done echo "----------------------------------------------------------------------"