The RDoc Dashboard Widget
Ruby API documentation at your fingertips!
This Mac OS X 10.4 (Tiger) Dashboard Widget is designed as a quick reference tool for Ruby programmers. It is able to display RDoc generated API documentation from any web source. Simply provide the URL to one of the RDoc repositories on the web to have all its documentation instantly available!
News: 13th June, 2005 - Version 1.2 Released!
Version 1.2 of the RDoc Dashboard Widget fixes several bugs (notably those involving erratic scrolling and pages stuck on 'network error') and introduces several new features:
- Resizable left-hand navigation pane
- Support for multiple instances of the widget on the dashboard
- Quick switching between RDoc repository URLs with bookmarking capabilities
- Persistence of widget dimensions between sessions
- Automatic update checking - the widget will let you know if a new version is available
Some sample repositories to try are:
- Ruby Core API - http://www.ruby-doc.org/core/
- Ruby on Rails Framework API - http://api.rubyonrails.com/
- RDoc API - http://rdoc.sourceforge.net/doc/
Download the RDoc Widget (v1.2)!
Mac OS X v.10.4 Tiger is required. If you're using Safari, click the download link. When the widget download is complete, show Dashboard, click the Plus sign to display the Widget Bar and click the widget's icon in the Widget Bar to open it. If you're using a browser other than Safari, click the download link. When the widget download is complete, unarchive it and place it in /Library/Widgets/ in your home folder. Show Dashboard, click the plus sign to display the Widget Bar and click the widget's icon in the Widget Bar to open it.
Any questions, bug reports or feedback? Contact us!
The IRB (Interactive Ruby) Dashboard Widget
Coming soon!