Ruby dictionary for Mac OS X
Feb 07, 2009
After publishing the Ruby on Rails dictionary for Mac OS X
, i got huge number of request to do the very same with Ruby API documentation. Fortunately, most of the work has already been done and now it's time to publish the Ruby dictionary
generated from Ruby API documentation.
If you've missed the Rails dictionary, then here's the short summary why this might be good for you. Basically, you just install extra dictionary into Mac OS X Dictionary.app with Ruby documentation and get system-wide access to API docs through the operating systems dictionary service.
One of the coolest things is to have access to documentation through Spotlight. While coding, just hit ⌘ + Space and start typing the name of the function or class name that you're looking for. Notice that dictionary search for Spotlight was first introduced in Mac OS X Leopard.
Unzip downloaded file into ~/Library/Dictionaries folder if you want to keep this dictionary only for yourself. You may need to create this folder if you haven't installed any dictionaries before.
To make it available for all users on your computer, drop the Ruby.Dictionary folder into /Library/Dictionaries folder.
To make the searching with Spotlight work, open Dictionary.app preferences pane and drag "Ruby" from the dictionaries list from bottom to the top because only the first one in this list will be searched from Spotlight.
I'm confident that using API documentation this way will save you a lot of time but generating and maintaining it will take a lot of mine. If you feel like donating, you can do this right here. If not, i could not be happier when you find it useful.
Please post your feedback in the comments or contact me via e-mail
. I'd love to discuss the format of dictionary pages and hear requests for additional Ruby gems that should make their way into dictionary.