Accessing RDoc fast using Quicksilver

Written on June 10 2009 at 09:32 and updated on June 15 2009 at 10:32

Inspired by this, but prefering Quicksilver to LaunchBar, I hacked up a neat little way to browse the excellent RailsApi docs using a Quicksilver trigger. It’s pretty simple to setup, and most of the credit goes to the original post and this trigger tutorial. Here’s how to do it:

As a bonus, you can also install this as an action.

Download the docs

Download the appropriate RDoc zip from RailsApi. Here’s what the interface looks like:

Selecting the rdoc to include in the downloaded RailsApi bundle

I chose basically everything, and I’ve unzip mine into ~/Sites/rdoc.

Create a virtual host

Next, we need some way of accessing the documentation. You can, of course, just double click the index.html file in the unzipped directory, but some of the later steps don’t seem to like file:// urls, so I’ve set up a really simple apache virtual host, using a tool I stole from Chris Roos called hostess.

sudo gem install hostess
sudo hostess create rdoc.local /Users/james/Sites/rdoc
chmod -R a+r /Users/james/Sites/rdoc

This will create a new virtual host for our RDoc, so we can access it using http://rdoc.local. Note that you must ensure that Apache can actually serve those files by making them readable by everyone.

It’s worth visiting the new virtual host now (http://rdoc.local) to make sure that it’s all working.

Add the Quicksilver trigger

Following the instructions here, it’s pretty simple to setup a custom keystroke trigger. First, copy this url:

http://rdoc.local/?q=***

Then open Quicksilver preferences (activate Quicksilver via whatever trigger you’ve set up, then type cmd+,), and choose the triggers tab

The Quicksilver triggers interface

Click on the + at the bottom to add a new hotkey

Adding a hotkey

Double click on the new entry, and you’ll see this window drop down:

Setting the trigger

Now, paste in the url from above. You should see it populate the fields of the new trigger panel (though yours probably won’t say ‘ruby method’ at the bottom, it’s important that there is some text in there):

Pasting in the trigger url

Finally, you’ll want to set a hotkey for the trigger. I’ve chosen cmd+alt+ctrl+R, but you can choose whatever you like. Double click on your trigger under the ‘Trigger’ column, and you’ll see this panel:

Setting the hotkey

Click on the ‘edit’ button, and then press all the keys for your trigger keystroke.

Now you’re good to go. Hit your trigger, then type the method name (or partial match), and hit enter.

Using the trigger

Boom - your local Ruby documentation will be opened, with the search performed.

Installing as a Quicksilver action

Another way of doing is is using Quicksilver actions. This lets you type some text, then hit tab and type ‘rdoc’, and then hit enter to perform your search. As you can see, the flow is flipped around a bit, but some people might prefer it this way. Open Script Editor, and paste in this script:

using terms from application "Quicksilver"
  on process text query
    set rdoc_url to "http://rdoc.local/?q=" & query
      tell application "Finder"
      open location rdoc_url
    end tell
  end process text
end using terms from

Save this script as ‘RDoc’ in ~/Library/Application Support/Quicksilver/Actions, and restart Quicksilver. Double Boom.


comments powered by Disqus