[GRASS-dev] Keywords in module descriptions

[Markus Neteler]

Hi,

I have added the keywords now in GRASS 6.3-CVS.
Each command has at least 1 keyword. We need to add
more of course, but they should be selected from a list
or so to avoid that identical things get different
keywords. Here the Wiki may be of use.

I have also updated all scripts for keyword support.

So far I didn't touch the TclTk interface to make
the keywords visible. I am not sure if this is really
desired.

Next week the HTML Web pages will contain the keywords.

Please extend them, it's simply done by adding them:

- in C programs: 
    module->keywords = _("a, b, ...");

- in shell scripts:
    keywords: a, b, ...


Question: Should I apply the patch to GRASS 6.2-release branch
as well?

Enjoy,
 
Markus

On Thu, Aug 17, 2006 at 09:49:32PM +0200, Markus Neteler wrote:
> 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

-- 
Markus Neteler  <neteler itc it>  http://mpa.itc.it/markus/
ITC-irst -  Centro per la Ricerca Scientifica e Tecnologica
MPBA - Predictive Models for Biol. & Environ. Data Analysis
Via Sommarive, 18        -       38050 Povo (Trento), Italy