Hi everyone - sorry if this is a bit OT, I''m not subscribed to the ''ruby-talk'' list, but if anyone wants to cross post this over there... This is just a quick announcement to let people know that I''ve built a basic RDoc Dashboard widget for Mac OS X Tiger. It''s still beta-ish, but seems to work okay for me - and it''s a convenient reference tool to boot :) It will read any RDoc repository (http://www.ruby-doc.org/core/ is the default, but http://api.rubyonrails.com/ works great as well) and lets you check your documentation without having to open a Safari/Firefox window. Anyways, any bug reports/criticism/comments are welcome... you can grab the widget from: http://widgets.precisionis.com.au/ I''m also working on an IRB widget which should be done shortly, if anyone''s interested. Have fun! -David Felstead
Hey David-
Really cool widget, I love it! I can''t wait for the irb widget.
But I found one smAll bug so far. The horizontal scroll bar at the
bottom of the Calesses Files Method''s panel does not work. Also,
would it be possible to make the panels resizable? So I could make
the classes panel a little wider? Thanks for the sweet widget.
-Ezra
On Jun 8, 2005, at 10:13 PM, David Felstead wrote:
> Hi everyone - sorry if this is a bit OT, I''m not subscribed to the
> ''ruby-talk'' list, but if anyone wants to cross post this
over there...
>
> This is just a quick announcement to let people know that I''ve
built a
> basic RDoc Dashboard widget for Mac OS X Tiger. It''s still
beta-ish,
> but seems to work okay for me - and it''s a convenient reference
tool
> to boot :)
>
> It will read any RDoc repository (http://www.ruby-doc.org/core/ is the
> default, but http://api.rubyonrails.com/ works great as well) and lets
> you check your documentation without having to open a Safari/Firefox
> window.
>
> Anyways, any bug reports/criticism/comments are welcome... you can
> grab the widget from:
>
> http://widgets.precisionis.com.au/
>
> I''m also working on an IRB widget which should be done shortly, if
> anyone''s interested.
>
> Have fun!
>
> -David Felstead
> _______________________________________________
> Rails mailing list
> Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org
> http://lists.rubyonrails.org/mailman/listinfo/rails
>
As someone that hasn''t been a huge fan of the dashboard, I must say that this rocks! I may actually start using the dashboard now :) Some problems/suggestions: Neither scroll bar seems to work, unless I use the mouse wheel first. Since, I don''t have a horizontal wheel, I can''t get the horizontal one to work at all. + 1 to resizing. I''d also like bookmarks, rather than copying the same couple of RDoc URLS over and over... I suppose I could just have multiple instances on my dashboard though. Great Job! -- rick http://techno-weenie.net
On Jun 8, 2005, at 11:13 PM, David Felstead wrote:> http://widgets.precisionis.com.au/ > ... > Have fun! > > -David FelsteadThank-you! This is fantastic. Duane Johnson (canadaduane)
David Felstead wrote: ...> Anyways, any bug reports/criticism/comments are welcome... you can > grab the widget from: > > http://widgets.precisionis.com.au/Some questions: How does the widget identify itself to the server (i.e. what is the user agent)? Does such a widget make people more likely to fetch files from ruby-doc.org than they might otherwise do if using a conventional browser? Is there any reason to believe the data from the Ruby API RDocs are better then what is in ri? Would an ri dashboard widget be faster for core Ruby API info (as well as being user-extensible)? Thanks, James Britt ruby-doc.org
David Felstead wrote: ... > Anyways, any bug reports/criticism/comments are welcome... you can > grab the widget from: > > http://widgets.precisionis.com.au/ Some questions: How does the widget identify itself to the server (i.e. what is the user agent)? Does such a widget make people more likely to fetch files from ruby-doc.org than they might otherwise do if using a conventional browser? Is there any reason to believe the data from the Ruby API RDocs are better then what is in ri? Would an ri dashboard widget be faster for core Ruby API info (as well as being user-extensible)? Thanks, James Britt ruby-doc.org
Hi James! On 6/10/05, James Britt <james.britt-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> > Some questions: > > How does the widget identify itself to the server (i.e. what is the user > agent)?The widget uses XMLHttpRequest to retireve data, so the user agent would be safari.> Does such a widget make people more likely to fetch files from > ruby-doc.org than they might otherwise do if using a conventional browser?I would imagine so, though personally I used to use my browser in the same way to browse ruby-doc.org and api.rubyonrails.com.> Is there any reason to believe the data from the Ruby API RDocs are > better then what is in ri? Would an ri dashboard widget be faster for > core Ruby API info (as well as being user-extensible)?Using ri locally would no doubt be faster - however, I''ve deliberately chosen to go down the web path for security reasons. The widget is configured not to allow access to local shell commands - this is because it fetches HTML (and potentially javascript) from untrusted sources (i.e. the web), which could potentially introduce malicious shell code into your system via javascript, for example: if(window.widget) widget.system(''/usr/bin/rm -rf ~/'', null); This could no doubt be overcome with some fancy coding, but I''d prefer not to take the risk... Alternatively, you could use RDoc/RI to generate the HTML representation of the API documentation and host it locally - this would work right now without any changes, just point the URL to http://localhost/myrdocdir/ Cheers! -David Felstead
Hi Rick, I''ve actually had this same feedback from a few people, so on the way soon should be: * Scrollbar fixes * Storage of multiple RDoc API repository URLs * Resizable classes/files/methods panel Cheers! -David Felstead On 6/10/05, Rick Olson <technoweenie-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote:> As someone that hasn''t been a huge fan of the dashboard, I must say > that this rocks! I may actually start using the dashboard now :) > > Some problems/suggestions: > > Neither scroll bar seems to work, unless I use the mouse wheel first. > Since, I don''t have a horizontal wheel, I can''t get the horizontal one > to work at all. > > + 1 to resizing. > > I''d also like bookmarks, rather than copying the same couple of RDoc > URLS over and over... I suppose I could just have multiple instances > on my dashboard though. > > Great Job! > > -- > rick > http://techno-weenie.net > _______________________________________________ > Rails mailing list > Rails-1W37MKcQCpIf0INCOvqR/iCwEArCW2h5@public.gmane.org > http://lists.rubyonrails.org/mailman/listinfo/rails >
David Felstead wrote:> Hi James! > > On 6/10/05, James Britt <james.britt-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org> wrote: > >>Some questions: >> >>How does the widget identify itself to the server (i.e. what is the user >>agent)? > > > The widget uses XMLHttpRequest to retireve data, so the user agent > would be safari.Can you have it report a more app-specific user agent so that I can track usage on ruby-doc.org? Thanks, James -- http://www.ruby-doc.org - The Ruby Documentation Site http://www.rubyxml.com - News, Articles, and Listings for Ruby & XML http://www.rubystuff.com - The Ruby Store for Ruby Stuff http://www.jamesbritt.com - Playing with Better Toys