Ubiquity-RDoc

Author: Luis Cipriani (lfcipriani at talleye dot com)
Contributors: Jens Wille, Tino Gomes

Last releases

Follow this project on GitHub: http://github.com/lfcipriani/ubiquity-rdoc/tree/master

• 2009-07-20: upgrade to support Ubiquity 0.5.x new Parser and backward compability with Parser 1
• 2009-04-07: set previewDelay to 800 miliseconds, improve on usability
• 2009-02-25: added 'rdoc-unload' command and some usability improvements
• 2009-01-04: highlight in first item of suggestion list, and a bugfix on rdoc-load validation
• 2008-12-10: better searching on methods and classes: [implemented the '#' modifier to do a advanced search on Class#method. Try it searching for 'rdoc String#delete in ruby' to see an example. You could also ommit the class or method like '#delete' or 'String#'.]
• 2008-12-09: persist user loaded rdoc data in browser: [default rdoc and rdoc indexes are stored on browser preferences, no need to reload each time the browser starts]

What is Ubiquity-RDoc?

A set of Mozilla Ubiquity commands for searching on Ruby rdocs.

How to use this command?

Do the following steps:

1. Install and learn Ubiquity

Install: Mozilla Ubiquity Wiki
Learn: Ubiquity User Tutorial
Or watch this video
Nice and easy.

2. Install Ubiquity-RDoc

After install Ubiquity, just access this page and follow the steps in Teaching Ubiquity New Commands

3. Use it

Ok, let's suppose that we want to read the description of "delete" method in rails, just start typing 'rdoc delete' and a box will show some suggestions:

But, in fact, we really want to access the "delete" method of ruby rdoc. Just continue typing 'in ruby'

Yes, rdoc command could switch the rdoc used on searching by just adding the modifier 'in + [rdoc name]'

Then, to access the documentation you could click an item or press enter to access the first item of the list. In the following picture, we clicked on "delete (String)" method.

Ubiquity-RDoc is released with rails and ruby rdocs, but, if you already know every method or class of these libraries and need to search on a different rdoc (for example, rspec), don't worry, you can load it by simply typing 'rdoc-load + [base URL] + as + [rdoc name]':

Base URL is the main page address of the rdoc, without 'index.html'. RDoc name is the name that you want to use when searching rdoc command, you can overwrite an existent rdoc index by just typing the same name used by rdoc command.

You could also use the 'rdoc-unload' command to remove unused rdocs.

Now, we can search on rspec documentation:

Finally, you could also change the default rdoc name used in searches. Type 'rdoc-default rspec'

And then, rdoc delete

TODO

• support to YARD and rdoc.info website
• method or class description preview
• search on all rdocs with 'rdoc delete in all' and 'rdoc-default all'

Contact

Any suggestion, bugs, etc, please, e-mail me: lfcipriani at talleye dot com

This project is also hosted on GitHub: http://github.com/lfcipriani/ubiquity-rdoc/tree/master