DeLynn Berry

Notes

Rails CHM Documentation - Version 1.0

Update - The latest version of the CHM documentation for Rails version 1.1.2 has been released and can be found here.

Back in August there was a Rails developer who released a CHM version of the Rails 0.13.0 documentation for those that have to develop on the Windows platform. I have been using that help file for the past few months even though there are several alternate ways of getting at the Rails documentation. For some reason, I always found myself using the CHM because of the index and quick search capabilities that it provides.

However, over the past couple of weeks I found myself no longer using the CHM file, but the Rails API website instead. The reason for this was simple: Rails moved to version 1.0 a couple of months ago and introduced several new features that the CHM file just didn’t cover.

I remember seeing a Wiki article that explained how to generate the CHM manually, so yesterday morning I set out to do just that with the Rails 1.0 source. Unfortunately, I ran into several problems (just like others have). What I thought was going to be a simple little RDoc task, ended becoming a debuging task that took most of the day to get everything just right.

Download the file from here!

In the next couple of days, I plan on releasing a RAKEFILE that will allow one to easily create the CHM file from the Rails source. I also will be making the CHM file available for any future version of Rails as soon after the release as possible so as to avoid the black-out type situation that we had during the past seven months.

So, let me know if you have any suggestions or have problems with the file and enjoy!

Filed under chm documentation projects rails