The IHelp (Interactive Help) package provides contextual help for objects and methods by using ri.
Requirements
* Ruby 1.8 * generated ri documentation * Ferret for full text search
Install
De-compress archive and enter its top directory. Then type: ($ su) # ruby setup.rb These simple step installs this program under the default location of Ruby libraries. You can also install files into your favorite directory by supplying setup.rb some options. Try "ruby setup.rb --help".
Usage
Example: require 'ihelp' 12.help "string".help :reverse # cute syntax - "string".help:reverse Array.help :map help "Array#map" # and, after generating ri docs for this (rdoc --ri ihelp/): IHelp.help To load IHelp automatically with irb, add the following to your .irbrc: require 'ihelp' If you think it makes the irb startup too slow, load it in a thread: Thread.new{ require 'ihelp' } Note that calling help will fail before it's completely loaded. This may not work on Windows, so only use it if absolutely necessary. Reindex the full text DB by running ihelp_reindex.rb.
See also
ri --help rdoc --help ruby --help The ruby-doc.org Ruby documentation project: http://www.ruby-doc.org/ Pickaxe book: http://www.ruby-doc.org/find/pickaxe Why's (Poignant) Guide to Ruby: http://poignantguide.net/ruby/
License
Ruby's
Ilmari Heikkinen <kig misfiring net> fhtr.org/projects/ihelp/
Generated with the Darkfish Rdoc Generator 2.