[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

[ANN] IHelp 0.4.0 - full text search

Ilmari Heikkinen

11/16/2006 9:46:00 PM

View and search object documentation from irb.

sudo gem install ihelp

Downloads: http://rubyforge.org/frs/?gro...
Documentation: http://ihelp.rub...
Project page: http://rubyforge.org/proje...
Screenshots:
http://ihelp.rub.../ihelp1.png
http://ihelp.rub.../ihelp2.png


REQUIREMENTS

* Generated RI docs (make install-doc)
* Ferret: http://rubyforge.org/proje...


NEW FEATURES

On a bit of a similar tack with Mauricio, I wrote a full-text search
over RI docs to IHelp. Being a good deal less hardcore than him, I
used Ferret to achieve the task.

I think we'll merge the shared functionality some day, I'd rather roll
all the nifty backend stuff into RI and have IHelp be a user interface
to it.


QUICK USAGE

"How do I justify a string?"
ihelp 'justifying strings'
ihelp 'How do I justify a string?' # watch out for noise words

"I need to read little-endian ints from a string"
> String.help 'little-endian int'

"Hmm, how does String#unpack work?"
> String.help:unpack

"Okay, so now I have this Array of ints, what was the syntax of inject again?"
> ints.help:inject

"What is this object and what can i do with it?"
> object.help

"Someone told me that I should look up Mutex#synchronize... but I
don't have that loaded."
> help "Mutex#synchronize"


LOADING AUTOMATICALLY IN IRB

Add the following to your .irbrc:

# Loading RI may take a second or two so let's make it
# snappier by loading in the background.
Thread.new do
require 'ihelp'
end

## If you don't like the colors in the search results
# IHelp.no_colors = true

## Renderer to use, one of 'ri', 'rubydoc', 'emacs', 'source', 'html'
## default is 'ri'
# IHelp.renderer = 'rubydoc'

## Web browser to use with renderers 'rubydoc' and 'html'
## default is 'firefox'
# IHelp.web_browser = 'konqueror'
6 Answers

Parragh Szabolcs

11/16/2006 10:03:00 PM

0

Ilmari Heikkinen írta:
> View and search object documentation from irb.
>
> sudo gem install ihelp
> gem install ihelp
Building native extensions. This could take a while...
No builder for extension 'lib/ihelp_reindex.rb'
ERROR: While executing gem ... (RuntimeError)
ERROR: Failed to build gem native extension.
Gem files will remain installed in
/usr/lib/ruby/gems/1.8/gems/ihelp-0.4.0 for inspection.
No builder for extension 'lib/ihelp_reindex.rb'

-- what can be the problem?

--
Parragh Szabolcs
e-mail: parragh@dayka.hu
web: parszab.nir.hu

Ilmari Heikkinen

11/16/2006 10:56:00 PM

0

> Thanks for noticing this, should be fixed in 0.4.1.

Make that 0.4.2. Which is out now.

Hugo R. Brandao

11/17/2006 1:51:00 AM

0

How can i unsubscribe??


Thanx.

Parragh Szabolcs

11/17/2006 7:45:00 AM

0

Ilmari Heikkinen írta:
>> Thanks for noticing this, should be fixed in 0.4.1.
>
> Make that 0.4.2. Which is out now.
0.4.3 was it this morning:) But I get the following on my Ubuntu box:

>> require 'ihelp'
/usr/lib/ruby/gems/1.8/gems/ihelp-0.4.3/lib/ihelp.rb:318: warning:
already initialized constant RI_ARGS
=> true
>> String.help:unpack

unrecognized option `--readline'

For help on options, try 'ri --help'

--> and irb exits.

--
Parragh Szabolcs
e-mail: parragh@dayka.hu
web: parszab.nir.hu

hemant

11/17/2006 11:36:00 AM

0

On 11/17/06, Hugo R. Brandao <brandaohugo@hotmail.com> wrote:
> How can i unsubscribe??
>
>
> Thanx.
>
>
Please read:

http://www.ruby-lang.org/en/community/mail...manual-ins...

http://www.ruby-lang.org/en/community/mail...

gnufied
--
There was only one Road; that it was like a great river: its springs
were at every doorstep, and every path was its tributary.

Parragh Szabolcs

11/18/2006 10:03:00 PM

0

Ilmari Heikkinen írta:
>
> And I thought I was doing a good thing passing ARGV to RI..
> Thanks for proving me wrong, disabled it in 0.4.4
I updatet -- now it's okay. But now irb opens the help text in the pager
-- can I turn it off?

--
Parragh Szabolcs
e-mail: parragh@dayka.hu
web: parszab.nir.hu