[GRASS5] 5.7: man pages extended

Hi,

I have modified the build script which generates
the HTML manual pages in 5.7 to add a one-line
description of each module. Like that you can
quickly search for a certain functionality.

So please keep on writing reasonable stuff into
module->description =
:slight_smile:

The online 5.7 manuals will auto-update next Saturday
as usual.
--
Another useful extension in the C code might be
the introduction of keywords. Per module maybe
2-5 keywords. But yes, a lot of work.

Markus

PS: New satellite image fusion script added to 5.7:
    i.fusion.brovey
    (LANDSAT-7 / SPOT / QuickBird, can be easily extended)

I have modified the build script which generates
the HTML manual pages in 5.7 to add a one-line
description of each module. Like that you can
quickly search for a certain functionality.

So please keep on writing reasonable stuff into
module->description =

...

Another useful extension in the C code might be
the introduction of keywords. Per module maybe
2-5 keywords. But yes, a lot of work.

Could it just search through the module->description strings? most of
the keywords will already be in there, & if not probably should be.
Adding keywords to every single module is a lot of work...

An exception might be where only one of Delaunay/Voronoi is mentioned in
the description, but I guess you could always rewrite the line it if
need be.

e.g. Debian's "apt-cache search foo" works on the included 2-3 sentence
descriptions.

Hamish

On Thu, May 06, 2004 at 06:16:05PM +1200, Hamish wrote:

> I have modified the build script which generates
> the HTML manual pages in 5.7 to add a one-line
> description of each module. Like that you can
> quickly search for a certain functionality.

Now online at:
http://grass.itc.it/grass51/manuals/html57_user/index.html
(auto-generated from CVS)

> So please keep on writing reasonable stuff into
> module->description =
...

> Another useful extension in the C code might be
> the introduction of keywords. Per module maybe
> 2-5 keywords. But yes, a lot of work.

Could it just search through the module->description strings? most of
the keywords will already be in there, & if not probably should be.
Adding keywords to every single module is a lot of work...

Probably we first have to implement an offline search engine
(something similar as provided by the R-stats where you can search
within local manual pages). Any ideas?

An exception might be where only one of Delaunay/Voronoi is mentioned in
the description, but I guess you could always rewrite the line it if
need be.

e.g. Debian's "apt-cache search foo" works on the included 2-3 sentence
descriptions.

Nice!

Markus

Markus Neteler <neteler@itc.it> wrote:

> > I have modified the build script which generates
> > the HTML manual pages in 5.7 to add a one-line
> > description of each module. Like that you can
> > quickly search for a certain functionality.

Now online at:
http://grass.itc.it/grass51/manuals/html57_user/index.html
(auto-generated from CVS)

> > So please keep on writing reasonable stuff into
> > module->description =
> ...
>
> > Another useful extension in the C code might be
> > the introduction of keywords. Per module maybe
> > 2-5 keywords. But yes, a lot of work.
>
> Could it just search through the module->description strings? most of
> the keywords will already be in there, & if not probably should be.
> Adding keywords to every single module is a lot of work...

Probably we first have to implement an offline search engine
(something similar as provided by the R-stats where you can search
within local manual pages). Any ideas?

How does the 'apropos' GNU tool do it?

> An exception might be where only one of Delaunay/Voronoi is mentioned in
> the description, but I guess you could always rewrite the line it if
> need be.
>
>
> e.g. Debian's "apt-cache search foo" works on the included 2-3 sentence
> descriptions.

H

Hamish wrote:

> Probably we first have to implement an offline search engine
> (something similar as provided by the R-stats where you can search
> within local manual pages). Any ideas?

How does the 'apropos' GNU tool do it?

apropos is a script which essentially just "grep"s the /usr/man/whatis
file (which is created by the makewhatis script).

--
Glynn Clements <glynn.clements@virgin.net>