GODI Search

GODI Search

[Gerd Stolpmann]

Hi list,

I've just released a new feature on docs.camlcity.org that is very
interesting for GODI and non-GODI users of O'Caml. It is a search engine
that allows you to search for identifiers and other words in an (almost)
full-blown GODI installation. I've developed this engine for the last
three weeks, and the results are already very interesting.

Just try it out here:

http://docs.camlcity.org

You can search for definitions of functions like "Hashtbl.fold", other
identifiers like "in_obj_channel", or just for "Xavier Leroy". The
search engine has some O'Caml parsing capabilities, and can e.g.
distinguish between value and type identifiers.

For the query syntax see

http://docs.camlcity.org/docs/syntax.html

The syntax resembles Google's.

The engine is not yet perfect. A number of errors are listed in the FAQ
document:

http://docs.camlcity.org/docs/faq.html

I would be glad to hear of more shortcomings - so I can fix or at least
document them soon. Feature wishes and other comments are also welcome.

Hope you like it,

Gerd
-- 
------------------------------------------------------------
Gerd Stolpmann * Viktoriastr. 45 * 64293 Darmstadt * Germany 
gerd@gerd-stolpmann.de          http://www.gerd-stolpmann.de
Phone: +49-6151-153855                  Fax: +49-6151-997714
------------------------------------------------------------

Re: [Caml-list] GODI Search

[Berke Durak]

[-- Attachment #1: Type: text/plain, Size: 409 bytes --]

Hello,

That's very nice work, Gerd.  Thanks.

Just one improvement:  when I search for List.map, I get the cmi_pretty and
the mli.  The mli should come
first IMHO, and when I click on the link, it should directly jump to the
definition of List.map which contains
the Ocamldoc as a comment.

The next step would be to parse the Ocamldoc and pretty-print it but it's
quite usable as it is now.
-- 
Berke Durak

[-- Attachment #2: Type: text/html, Size: 471 bytes --]

Re: [Caml-list] GODI Search

[Mehdi]

[-- Attachment #1: Type: text/plain, Size: 225 bytes --]

On Tue, Apr 22, 2008 at 12:30 AM, Gerd Stolpmann <info@gerd-stolpmann.de>
wrote:

> Hi list,
>
> I've just released a new feature on docs.camlcity.org


Is it opensource ?

-- 
Mehdi Dogguy
http://www.pps.jussieu.fr/~dogguy/

[-- Attachment #2: Type: text/html, Size: 600 bytes --]

Re: [Caml-list] GODI Search

[Gerd Stolpmann]

Am Mittwoch, den 23.04.2008, 10:39 +0200 schrieb Berke Durak:
> Hello,
> 
> That's very nice work, Gerd.  Thanks.
> 
> Just one improvement:  when I search for List.map, I get the
> cmi_pretty and the mli.  The mli should come
> first IMHO,

Yes, I agree. I was also thinking about aggregating files that probably
show the same module. That could look like:

List(.mli) - [value] from godi-ocaml (Score: 20000) 
list -> unit val map : ('a -> 'b) -> 'a list -> 'b list val rev_map :
('a -> 'b) -> 'a list -> 'b 

    Alternate Views: List(.cmi_pretty) List(.ml) ...

> and when I click on the link, it should directly jump to the
> definition of List.map which contains
> the Ocamldoc as a comment.

This is implemented. Have a closer look: You can click on the title of
the file (List) and directly on "map". If you do the latter, it jumps
directly to the definition. However, this works only for text files and
not for html files.

> The next step would be to parse the Ocamldoc and pretty-print it but
> it's quite usable as it is now.

The Ocamldoc parser is only half-completed, but I am already working on
this.

Thanks for your feedback,

Gerd
-- 
------------------------------------------------------------
Gerd Stolpmann * Viktoriastr. 45 * 64293 Darmstadt * Germany 
gerd@gerd-stolpmann.de          http://www.gerd-stolpmann.de
Phone: +49-6151-153855                  Fax: +49-6151-997714
------------------------------------------------------------

Re: [Caml-list] GODI Search

[Gerd Stolpmann]

Am Mittwoch, den 23.04.2008, 12:24 +0200 schrieb Mehdi:
> 
> 
> On Tue, Apr 22, 2008 at 12:30 AM, Gerd Stolpmann
> <info@gerd-stolpmann.de> wrote:
>         Hi list,
>         
>         I've just released a new feature on docs.camlcity.org 
> 
> Is it opensource ?

No, it's not open-source. At least not in the current stage of
development.

Gerd
-- 
------------------------------------------------------------
Gerd Stolpmann * Viktoriastr. 45 * 64293 Darmstadt * Germany 
gerd@gerd-stolpmann.de          http://www.gerd-stolpmann.de
Phone: +49-6151-153855                  Fax: +49-6151-997714
------------------------------------------------------------

Re: [Caml-list] GODI Search

[Berke Durak]

[-- Attachment #1: Type: text/plain, Size: 946 bytes --]

On Wed, Apr 23, 2008 at 12:31 PM, Gerd Stolpmann <info@gerd-stolpmann.de>
wrote:

>
> > and when I click on the link, it should directly jump to the
> > definition of List.map which contains
> > the Ocamldoc as a comment.
>
> This is implemented. Have a closer look: You can click on the title of
> the file (List) and directly on "map". If you do the latter, it jumps
> directly to the definition. However, this works only for text files and
> not for html files.


The focus is lost when I select another tab.  For instance when I click on
the list.mli tab after having selected the list.ml result.

> The next step would be to parse the Ocamldoc and pretty-print it but
> > it's quite usable as it is now.
>
> The Ocamldoc parser is only half-completed, but I am already working on
> this.


Will you be able to handle all the traffic when people start using GODI
search
for browsing the APIs? We don't want to bankrupt you :)
-- 
Berke Durak

[-- Attachment #2: Type: text/html, Size: 1593 bytes --]

Re: [Caml-list] GODI Search

[Gerd Stolpmann]

Am Mittwoch, den 23.04.2008, 12:45 +0200 schrieb Berke Durak:
> On Wed, Apr 23, 2008 at 12:31 PM, Gerd Stolpmann
> <info@gerd-stolpmann.de> wrote:
> 
>         
>         > and when I click on the link, it should directly jump to the
>         > definition of List.map which contains
>         > the Ocamldoc as a comment.
>         
>         
>         This is implemented. Have a closer look: You can click on the
>         title of
>         the file (List) and directly on "map". If you do the latter,
>         it jumps
>         directly to the definition. However, this works only for text
>         files and
>         not for html files.
> 
> The focus is lost when I select another tab.  For instance when I
> click on
> the list.mli tab after having selected the list.ml result.

Right. I am not sure how to address this. I would like to avoid that any
"?" parameters appear in the result list, because the "real" search
engines like Google would interpret then every occurrence of a word as
different document, e.g. list.mli?q=map and list.mli?q=fold_left would
be seen as two different docs.

>         > The next step would be to parse the Ocamldoc and
>         pretty-print it but
>         > it's quite usable as it is now.
>         
>         
>         The Ocamldoc parser is only half-completed, but I am already
>         working on
>         this.
> 
> Will you be able to handle all the traffic when people start using
> GODI search
> for browsing the APIs? We don't want to bankrupt you :)

I'm well-prepared for a storm of queries :-)


Gerd
-- 
------------------------------------------------------------
Gerd Stolpmann * Viktoriastr. 45 * 64293 Darmstadt * Germany 
gerd@gerd-stolpmann.de          http://www.gerd-stolpmann.de
Phone: +49-6151-153855                  Fax: +49-6151-997714
------------------------------------------------------------

Re: [Caml-list] GODI Search

[Stefano Zacchiroli]

On Wed, Apr 23, 2008 at 12:33:03PM +0200, Gerd Stolpmann wrote:
> > Is it opensource ?
> No, it's not open-source. At least not in the current stage of
> development.

Sorry for pressing you, will it become open-source that anytime soon?

An intriguing idea I've in mind for the OCaml-oriented forge (which
forge.ocamlcore.org is supposed to become) it to provide some forge-wide
services which are OCaml specific. One was an automatic periodic
compilation together with the generation of ocamldoc documentation.
(Let's leave aside for the moment the technical requirements of such a
set up.)

Having so, it would be a pity to reimplement the functionalities you
have just shown us, really wetting our appetites :-)

I don't want to press you, just to have an idea of what to expect ...

TIA,
Cheers.

-- 
Stefano Zacchiroli -*- PhD in Computer Science ............... now what?
zack@{upsilon.cc,cs.unibo.it,debian.org}  -<%>-  http://upsilon.cc/zack/
(15:56:48)  Zack: e la demo dema ?    /\    All one has to do is hit the
(15:57:15)  Bac: no, la demo scema    \/    right keys at the right time