[GRASS-dev] Keywords in module descriptions

[Trevor Wiens]

On Fri, 18 Aug 2006 10:02:37 -0700
Michael Barton <michael.barton at asu.edu> wrote:

> Markus,
> 
> I think this is an excellent idea. If we get these keywords arranged right
> (it will probably take some experimentation, but you might start with the
> current menu hierarchy), it will not only help documentation but could serve
> as the basis for an autogenerated menu/toolbox.
> 

For searching it would be invaluable. I also like Michael's thinking
about a way to approach this problem of organizing the vast number of
modules we have. If seen as a method for this organization of a menu /
toolbox, then it might be advisable to come up with a formal list of
keywords that all modules will need to include at least one or two
(depending on how this is organized) as well as any others to help in
searching.

T

> Michale
> __________________________________________
> Michael Barton, Professor of Anthropology
> School of Human Evolution & Social Change
> Center for Social Dynamics and Complexity
> Arizona State University
> 
> phone: 480-965-6213
> fax: 480-965-7671
> www: http://www.public.asu.edu/~cmbarton
> 
> 
> > From: Markus Neteler <neteler at itc.it>
> > Date: Thu, 17 Aug 2006 21:49:32 +0200
> > To: GRASS developers list <grass-dev at grass.itc.it>
> > Subject: [GRASS-dev] Keywords in module descriptions
> > 
> > Hi,
> > 
> > a proposal for a better navigatable documentation of GRASS:
> > I would like to add
> > 
> >     module->keywords = _("a, b, c, d");
> > 
> > to each command. These keywords would then
> > - automatically appear in each HTML/MAN page
> > - be content of the XML output by --interface-description
> >   (maybe parsable then <keywords>a, b, c, d</keywords> for
> >    automated GUI arranging?)
> > - probably made visible in the TclTk GUI if we want that
> > - visible in the "help" text, example:
> > 
> > r.cost help
> > 
> > Description:
> >  Outputs a raster map layer showing the cumulative cost of moving between
> > different geographic locations on an input raster map layer whose cell
> > category values represent cost.
> > 
> > Keywords:
> >  raster map, cost surface, cumulative costs
> > 
> > Usage:
> >  r.cost [-vknr] input=name output=name [start_points=string]
> >    [stop_points=string] [start_rast=string] [coordinate=x,y[,x,y,...]]
> >    [stop_coordinate=x,y[,x,y,...]] [max_cost=cost] [null_cost=null cost]
> >    [percent_memory=percent memory] [--overwrite]
> > 
> > ...
> > 
> > I have it running on my PC for r.cost.
> > With a sed job I could substitute all
> >    module->description = ...
> > 
> > by
> >    module->keywords = _("a, b, c, d");
> >    module->description = ...
> > automatically.
> > 
> > Maybe we could make a Web application to visualize the keywords
> > like a navigatable tree or "TouchGraph" [1] or whatever appropriate.
> > 
> > Any objections?
> > 
> > Markus
> > 
> > [1] Just as an selfish example (needs Java):
> >     http://www.citeulike.org/nocrawl/touchgraph_applet.adp?article_id=172900
> >     (double click on the floating objects to navigate)
> > 
> > 
> 
> _______________________________________________
> grass-dev mailing list
> grass-dev at grass.itc.it
> http://grass.itc.it/mailman/listinfo/grass-dev


-- 
Trevor Wiens 
twiens at interbaun.com

The significant problems that we face cannot be solved at the same 
level of thinking we were at when we created them. 
(Albert Einstein)