Smalltalk › Pharo › Pharo Smalltalk Developers

Online Pharo Documentation

_‹ Previous Topic Next Topic _›

Classic

List

Threaded

6 messages Options

Camillo Bruni

Online Pharo Documentation

Hi everyone,

During the last month I worked a bit on my pharo web documentation tool.
It's a derivate of ruby's http://yardoc.org/ running on top of seaside.

A test image is available here:
http://dl.dropbox.com/u/18184943/WebDoc.zip
Open the image then access the documentation in your browser
http://localhost:8080/doc

There are still some glitches due to the javascript fancyness around.

Features:
- browse and filter packages
- browse and filter classes of packages
- Class overview with markdown enabled comments
- fully annotated source code with popups for known types and selectors

Missing:
- fully functional and slightly more intelligent search for methods, classes and packages
- hierarchical display of packages
- bookmarkable links don't work yet.

Please feel free to add your own wishes, I hope to slowly improve this webdoc to make it really usable.

v(^_^)v
camillo

Stéphane Ducasse

Re: Online Pharo Documentation

***thanks*** camillo
it would be gorgeous in the future to have a new webdoc for the currently released version of pharo.

Stef
On Apr 22, 2011, at 9:52 PM, Camillo Bruni wrote:

> Hi everyone,
>
> During the last month I worked a bit on my pharo web documentation tool.
> It's a derivate of ruby's http://yardoc.org/ running on top of seaside.
>
> A test image is available here:
> http://dl.dropbox.com/u/18184943/WebDoc.zip
> Open the image then access the documentation in your browser
> http://localhost:8080/doc
>
> There are still some glitches due to the javascript fancyness around.
>
> Features:
> - browse and filter packages
> - browse and filter classes of packages
> - Class overview with markdown enabled comments
> - fully annotated source code with popups for known types and selectors
>
> Missing:
> - fully functional and slightly more intelligent search for methods, classes and packages
> - hierarchical display of packages
> - bookmarkable links don't work yet.
>
> Please feel free to add your own wishes, I hope to slowly improve this webdoc to make it really usable.
>
> v(^_^)v
> camillo

Stéphane Ducasse

Re: Online Pharo Documentation

In reply to this post by Camillo Bruni

Camillo

could use the convention of coral for the short class description?
If I remember it is

Object <| Point

because like that it looks like the UML triangle.

Stef

laurent laffont

Re: Online Pharo Documentation

In reply to this post by Camillo Bruni

That's really nice Camillo. Thank you. I hope to see it online soon ;)

Laurent.

On Fri, Apr 22, 2011 at 9:52 PM, Camillo Bruni <[hidden email]> wrote:

Hi everyone,

During the last month I worked a bit on my pharo web documentation tool.
It's a derivate of ruby's http://yardoc.org/ running on top of seaside.

A test image is available here:
http://dl.dropbox.com/u/18184943/WebDoc.zip
Open the image then access the documentation in your browser
http://localhost:8080/doc

There are still some glitches due to the javascript fancyness around.

Features:
- browse and filter packages
- browse and filter classes of packages
- Class overview with markdown enabled comments
- fully annotated source code with popups for known types and selectors

Missing:
- fully functional and slightly more intelligent search for methods, classes and packages
- hierarchical display of packages
- bookmarkable links don't work yet.

Please feel free to add your own wishes, I hope to slowly improve this webdoc to make it really usable.

v(^_^)v
camillo

Bernat Romagosa

Re: Online Pharo Documentation

Just tried the demo image, very nice job!

Maybe we could set up a running instance somewhere and link it from the Pharo website?

Bernat.

2011/4/22 laurent laffont <[hidden email]>

That's really nice Camillo. Thank you. I hope to see it online soon ;)

Laurent.

On Fri, Apr 22, 2011 at 9:52 PM, Camillo Bruni <[hidden email]> wrote:

Hi everyone,

During the last month I worked a bit on my pharo web documentation tool.
It's a derivate of ruby's http://yardoc.org/ running on top of seaside.

A test image is available here:
http://dl.dropbox.com/u/18184943/WebDoc.zip
Open the image then access the documentation in your browser
http://localhost:8080/doc

There are still some glitches due to the javascript fancyness around.

Features:
- browse and filter packages
- browse and filter classes of packages
- Class overview with markdown enabled comments
- fully annotated source code with popups for known types and selectors

Missing:
- fully functional and slightly more intelligent search for methods, classes and packages
- hierarchical display of packages
- bookmarkable links don't work yet.

Please feel free to add your own wishes, I hope to slowly improve this webdoc to make it really usable.

v(^_^)v
camillo

Camillo Bruni

Re: Online Pharo Documentation

I am currentlz hacking together a fulltext search index using solr.. once that is running I consider the project to be more or less complete ;).

and yeah, then I should get it up and running somewhere :)

camillo

On 2011-04-26, at 13:00, Bernat Romagosa wrote:

Just tried the demo image, very nice job!

Maybe we could set up a running instance somewhere and link it from the Pharo website?

Bernat.
2011/4/22 laurent laffont <[hidden email]>

That's really nice Camillo. Thank you. I hope to see it online soon ;)

Laurent.

On Fri, Apr 22, 2011 at 9:52 PM, Camillo Bruni <[hidden email]> wrote:

Hi everyone,

During the last month I worked a bit on my pharo web documentation tool.
It's a derivate of ruby's http://yardoc.org/ running on top of seaside.

A test image is available here:
http://dl.dropbox.com/u/18184943/WebDoc.zip
Open the image then access the documentation in your browser
http://localhost:8080/doc

There are still some glitches due to the javascript fancyness around.

Features:
- browse and filter packages
- browse and filter classes of packages
- Class overview with markdown enabled comments
- fully annotated source code with popups for known types and selectors

Missing:
- fully functional and slightly more intelligent search for methods, classes and packages
- hierarchical display of packages
- bookmarkable links don't work yet.

Please feel free to add your own wishes, I hope to slowly improve this webdoc to make it really usable.

v(^_^)v
camillo