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


 

Forums >

comp.lang.ruby

Ruby 1.8.6 *stripped* documentation

ex

12/30/2007 12:59:00 AM


Hi all:

I have been playing for a while with Ruby, and I'm enjoying it.
However I was missing an up to date CHM version of the documentation
for the release I'm using (1.8.6). My only source of documentation was
the "Programming Ruby" book that comes with the Windows installation,
and it was a bit outdated: Ruby 1.6. So I googled for one but only
found a CHM version for Rails. Instead of looking more I downloaded
the source and used RDoc for generating the CHM file, it was not
straightforward: the CHM compiler was crashing, I needed to use the
flag: --inline-source and after that I got my flashy new CHM file. But
it was full of many empty entries and libraries I don't use right now.
I selected some entries and created a *stripped* version. If this
helps others like me it would be nice.

http://elrinconde-ex.blogspot.com/2007/12/ruby-185-stripped-document...

EDIT:
The direct link is: http://rapidshare.com/files/79426241/ruby_1.8.6_stripped_documentatio...
6 Answers

Luis Lavena

12/30/2007 1:33:00 AM

0

On 29 dic, 21:58, ex <exeQ...@gmail.com> wrote:
> Hi all:
>
> I have been playing for a while with Ruby, and I'm enjoying it.
> However I was missing an up to date CHM version of the documentation
> for the release I'm using (1.8.6). My only source of documentation was
> the "Programming Ruby" book that comes with the Windows installation,
> and it was a bit outdated: Ruby 1.6. So I googled for one but only
> found a CHM version for Rails. Instead of looking more I downloaded
> the source and used RDoc for generating the CHM file, it was not
> straightforward: the CHM compiler was crashing, I needed to use the
> flag: --inline-source and after that I got my flashy new CHM file. But
> it was full of many empty entries and libraries I don't use right now.
> I selected some entries and created a *stripped* version. If this
> helps others like me it would be nice.
>
> http://elrinconde-ex.blogspot.com/2007/12/ruby-185-stripped......
>
> EDIT:
> The direct link is:http://rapidshare.com/files/79426241/ruby_1.8.6_stripped_do......

Great work ex!

There are still a few "MISSING" there, but so far, is excellent.

If you like to contribute to One-Click Installer, please use the
Rubyforge tracker and provide us with information how to get it
working.

http://rubyforge.org/tracker/?gr...

Also, if there was some problem with RDocs and you can fix them, will
be good you provide RDoc patches to Ruby itself:

http://rubyforge.org/pro...

Keep it working, looks good! :-)

--
Luis Lavena

ex

12/30/2007 2:38:00 PM

0

Hi Luis!
Seems my post got missing... I'll try to post again with the risk of
double posting, sorry!

> Great work ex!
> There are still a few "MISSING" there, but so far, is excellent.

Thank you. What are the missing parts? Since I did this for newbies
like my to the language I'm open to ideas for things to improve, I
don't know what libraries are the most used I was just aiming for a
simple core documentation, any imput would be welcome.


> If you like to contribute to One-Click Installer, please use the
> Rubyforge tracker and provide us with information how to get it
> working.
>
> http://rubyforge.org/tracker/?gr...
>
> Also, if there was some problem with RDocs and you can fix them, will
> be good you provide RDoc patches to Ruby itself:
>
> http://rubyforge.org/pro...
>

I edited the automated output files by hand (yes, I feel guilty...)
I was just a little anxious for my CHM file.
If you ask I can uploaded my edited files, however these are going to
work only for
the 1.8.6-p111 source code help files.

Best Regards!

Bernard Kenik

12/31/2007 5:51:00 PM

0

On Dec 29, 7:58 pm, ex <exeQ...@gmail.com> wrote:
> Hi all:
>
> I have been playing for a while with Ruby, and I'm enjoying it.
> However I was missing an up to date CHM version of the documentation
> for the release I'm using (1.8.6). My only source of documentation was
> the "Programming Ruby" book that comes with the Windows installation,
> and it was a bit outdated: Ruby 1.6. So I googled for one but only
> found a CHM version for Rails. Instead of looking more I downloaded
> the source and used RDoc for generating the CHM file, it was not
> straightforward: the CHM compiler was crashing, I needed to use the
> flag: --inline-source and after that I got my flashy new CHM file. But
> it was full of many empty entries and libraries I don't use right now.
> I selected some entries and created a *stripped* version. If this
> helps others like me it would be nice.
>
> http://elrinconde-ex.blogspot.com/2007/12/ruby-185-stripped......
>
> EDIT:
> The direct link is:http://rapidshare.com/files/79426241/ruby_1.8.6_stripped_do......

The links are upload links and not the download link.

Please post the upload link,

Thank you

bbiker

Shin guey Wong

1/1/2008 3:46:00 PM

0

ex wrote:

> http://elrinconde-ex.blogspot.com/2007/12/ruby-185-stripped-document...
>
> EDIT:
> The direct link is:
> http://rapidshare.com/files/79426241/ruby_1.8.6_stripped_documentatio...

Good work. I really like the chm documentation. It should be included in
the one clicked installer and for sure it will be really helpful. I
prefer this documentation instead of the ri command. Including the ri
documenation make the one click installer consume more time to install
due to so many small file need to extract and copy to the system.
--
Posted via http://www.ruby-....

Luis Lavena

1/2/2008 1:30:00 AM

0

On 1 ene, 13:46, Shin guey Wong <sgwong...@hotmail.com> wrote:
> ex wrote:
> >http://elrinconde-ex.blogspot.com/2007/12/ruby-185-stripped......
>
> > EDIT:
> > The direct link is:
> >http://rapidshare.com/files/79426241/ruby_1.8.6_stripped_do......
>
> Good work. I really like the chm documentation. It should be included in
> the one clicked installer and for sure it will be really helpful. I
> prefer this documentation instead of the ri command. Including the ri
> documenation make the one click installer consume more time to install
> due to so many small file need to extract and copy to the system.

I was thinking the same, that's why I checked the file.

Here are the "missing" parts.

Class: Bignum, coerce (p1)
Class: Method, clone()
Class: Proc, clone()
Class: Proc, dup()
Class: UnboundMethod, clone()

That means there is missing documentation in Ruby, but the CHM just
exposed it.

I'll love to include this file instead of RI documentation (actually,
I even install gems with --no-ri --no-rdoc).

Huge folers with so many files (like yaml documentation) hit Windows
MFT so hard that fragment $MFT area quickly. There is also the penalty
of compressing all these files.

So, please, feel free to open a Feature Request and document the whole
process so we can implement it in the future version of One-Click
Installer!

Keep the good work! :)
(and have a nice new year!)

Regards,

Luis Lavena

ex

1/3/2008 3:54:00 AM

0

> I was thinking the same, that's why I checked the file.
>
> Here are the "missing" parts.
>
> Class: Bignum, coerce (p1)
> Class: Method, clone()
> Class: Proc, clone()
> Class: Proc, dup()
> Class: UnboundMethod, clone()
>
> That means there is missing documentation in Ruby, but the CHM just
> exposed it.
>
> I'll love to include this file instead of RI documentation (actually,
> I even install gems with --no-ri --no-rdoc).
>
> Huge folers with so many files (like yaml documentation) hit Windows
> MFT so hard that fragment $MFT area quickly. There is also the penalty
> of compressing all these files.
>
> So, please, feel free to open a Feature Request and document the whole
> process so we can implement it in the future version of One-Click
> Installer!
>
> Keep the good work! :)
> (and have a nice new year!)
>
> Regards,
>
> Luis Lavena


Hi Luis.
nice new year for you too!

I just opened a feature request in the tracker, write the steps and
uploaded the files necessary for you compile the CHM, please feel free
to check if everything is working for this to be included in the one
click installer, I would be very happy and maybe others :)

STEPS:

- Download the ruby 1.8.6-p111 source release and unzip.
- Create a help directory in the source tree.
- Launche the next console command:
rdoc --inline-source --line-numbers --fmt chm --op help
- extract the attached files in the help directory (this replace the
originals)
- compile the project (hhp file) using MS HelpWorkshop (free)