fxri is an interface to Ruby's RI documentation. It has several nice
features:
* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.
fxri is available via ruby gem, just type
gem install fxri
Here is a screenshot:
http://martinus.geekisp.com/rublog.cgi/Projects/fxri/fxri.html
martinus
martinus ha scritto:
fxri is an interface to Ruby's RI documentation. It has several nice
features:* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.fxri is available via ruby gem, just type
gem install fxri
Here is a screenshot:
http://martinus.geekisp.com/rublog.cgi/Projects/fxri/fxri.html
mh.. maybe RBBR is still cooler, but this is definitely a nice app 
maybe another nice addition to FreeRIDE?
wow looks/sounds nice!!!
now i've got to get this working on osx 
Alex
On Feb 20, 2005, at 1:14 PM, martinus wrote:
fxri is an interface to Ruby's RI documentation. It has several nice
features:* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.fxri is available via ruby gem, just type
gem install fxri
Here is a screenshot:
http://martinus.geekisp.com/rublog.cgi/Projects/fxri/fxri.html
martinus
first fxirb, now fxri. Very nice indeed. Now who'll give us fxr? 
Thanks again.
M
On Sun, 20 Feb 2005 21:14:42 +0900, martinus <martin.ankerl@gmail.com> wrote:
fxri is an interface to Ruby's RI documentation. It has several nice
features:* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.fxri is available via ruby gem, just type
--
Matt Mower :: http://matt.blogs.it/
Can you tell me how to get fxri to pickup 3rd party documentation,
e.g. gems. I'd love to be able to use it for Rails documentation.
It would also be neat if there was a way to use it for the rails console.
M
On Sun, 20 Feb 2005 21:14:42 +0900, martinus <martin.ankerl@gmail.com> wrote:
fxri is an interface to Ruby's RI documentation. It has several nice
features:* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.
--
Matt Mower :: http://matt.blogs.it/
Wonderful stuff!
martin
martinus <martin.ankerl@gmail.com> wrote:
fxri is an interface to Ruby's RI documentation. It has several nice
features:
martinus wrote:
gem install fxri
The fxri tarball works fine. Nice work!
But I got stuck on the gem install:
I have Fox/FXRuby 1.2:
# ruby -r fox12 -e 1
And these are my versions:
# gem -v
0.8.4
# ruby -v
ruby 1.8.2 (2004-12-25) [i686-linux]
# gem install fxri
Attempting local installation of 'fxri'
Local gem file not found: fxri*.gem
Attempting remote installation of 'fxri'
Updating Gem source index for: http://gems.rubyforge.org
Install required dependency fxruby? [Yn] n
ERROR: While executing gem ... (Gem::DependencyError)
Required dependency fxruby not installed
# gem install fxri -f
Attempting local installation of 'fxri'
Local gem file not found: fxri*.gem
Attempting remote installation of 'fxri'
Updating Gem source index for: http://gems.rubyforge.org
Install required dependency fxruby? [Yn] n
ERROR: While executing gem ... (Gem::DependencyError)
Required dependency fxruby not installed
# gem install fxri
Attempting local installation of 'fxri'
Local gem file not found: fxri*.gem
Attempting remote installation of 'fxri'
Install required dependency fxruby? [Yn] Y
Select which gem to install for your platform (i686-linux)
1. fxruby 1.2.3 (mswin32)
2. fxruby 1.2.3 (ruby)
3. fxruby 1.2.2 (ruby)
4. fxruby 1.2.2 (mswin32)
5. fxruby 1.2.1 (mswin32)
6. fxruby 1.2.1 (ruby)
7. Cancel installation
> 7
ERROR: While executing gem ... (Gem::RemoteInstallationCancelled)
Installation of fxruby cancelled.
So why can't gem -f force use of the existing fox12 installation?
martinus wrote:
fxri is an interface to Ruby's RI documentation. It has several nice
features:* Search Engine with search-on-typing
* Includes Martin DeMello's excellent fxirb.
* Syntax-highlited ri output.fxri is available via ruby gem, just type
gem install fxri
Here is a screenshot:
http://martinus.geekisp.com/rublog.cgi/Projects/fxri/fxri.html
Very cool! This will be very useful! Great work Martin!
Zach
Can you tell me how to get fxri to pickup 3rd party documentation,
e.g. gems. I'd love to be able to use it for Rails documentation.
fxri uses the same source as ri, so you have to use
rdoc -r sourcedirectory
to generate the ri documentation. E.g. to generate the fxruby docs, I have done this:
rdoc -r /usr/lib/ruby/gems/1.8/gems/fxruby-1.2.3/rdoc-sources
voila, more than 1500 new entries for fxri
It would also be neat if there was a way to use it for the rails console.
I have never used rails, so I cannot say how difficult this is
martinus
gabriele renzi wrote:
mh.. maybe RBBR is still cooler, but this is definitely a nice app
maybe another nice addition to FreeRIDE?
Definitely so. Actually I'm already working on it as I write this message. I will soon send a patch to Martin so that it is easier for us to integrate in FreeRIDE while preserving the fxri standalone application.
Laurent
mh.. maybe RBBR is still cooler, but this is definitely a nice app
Oh! I am glad I did not know RBBR beforehand, otherwise I probably would not have bothered to write fxri
martinus
Martin Ankerl wrote:
Can you tell me how to get fxri to pickup 3rd party documentation,
e.g. gems. I'd love to be able to use it for Rails documentation.fxri uses the same source as ri, so you have to use
rdoc -r sourcedirectory
to generate the ri documentation. E.g. to generate the fxruby docs, I have done this:rdoc -r /usr/lib/ruby/gems/1.8/gems/fxruby-1.2.3/rdoc-sources
voila, more than 1500 new entries for fxri
But, be warned: if you are not careful with what you import into ri, you can add entries to core library ri info (if any new source doc modifies core classes)
Also, there may be a bug related to 3rd party docs (or, more specifically, docs that do not fit a certain structure expected by ri ).
I just installed fxri via rubygems, and saw that the ri data for my Catapult library was available. All the entries are prefixed Neurogami::Catapult; as I type out most of the first term, I get an exception:
c:/ruby/lib/ruby/1.8/rdoc/ri/ri_descriptions.rb:99:in `concat': cannot convert nil into Array (TypeError)
from c:/ruby/lib/ruby/1.8/rdoc/ri/ri_descriptions.rb:99:in `merge_in'
from c:/ruby/lib/ruby/1.8/rdoc/ri/ri_reader.rb:56:in `get_class'
from c:/ruby/lib/ruby/1.8/rdoc/ri/ri_reader.rb:52:in `each'
from c:/ruby/lib/ruby/1.8/rdoc/ri/ri_reader.rb:52:in `get_class'
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./lib/RiManager.rb:102:in `report_class_stuff'
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./lib/RiManager.rb:96:in `show'
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./fxri:262:in `on_show'
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./fxri:270:in `show_info'
... 10 levels...
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./fxri:292:in `run'
from c:/ruby/lib/ruby/gems/1.8/gems/fxri-0.1.0/./fxri:292
from c:/ruby/bin/fxri:19:in `load'
from c:/ruby/bin/fxri:19
I get essentially the same error if I run
c:\>ri Neurogami
at the command line.
But in that instance I have no reason to do that; I'd type out the full prefix before hitting Enter.
It seems that fxri dies on exceptions percolated up from ri, and the dynamic search-while-typing part using ri barfs midway through Neurogami::Catapult, as nothing is defined for just that first term.
Seems that if you have docs in the name space Foo::Bar, and Foo is (I'm guess) empty in some ri-special way, fxri breaks when it tries to call "ri Foo".
James