Posts tagged chm documentation
Posts tagged chm documentation
I know Rails 2.0.2 was released over three months ago, so this release is way late, but today I was able to get around to creating the CHM version of the Rails Documentation. You can download the file from the product page or directly from this link.
A new release of the Rails framework means it’s time for a new version of the CHM Documentation file.
Download the latest version from here.
Since the first release candidate of Rails 1.2.0 was announced yesterday, I decided to update the CHM documentation to match this latest release. You can find the updated file via my CHM Documentation Project Page, or just download the file directly from here.
Please note that ActiveResource was pulled from 1.2.0 as of revision 5554, so its documentation is not included in the above file. If you are running off of trunk and want/need the ActiveResource documentation, then you should download my latest trunk CHM file from here.
So, I was able to take the time last night to put together a CHM document that contains documentation for revision 5315 of Rails trunk. You can find the file here.
For more information related to what’s new in Rails, be sure to read Ryan Daigle’s category “what’s new in rails“—great stuff.
It’s been a long time coming, but I just posted an update to my Rails CHM Documentation file. This update has the documentation for the 1.1.6 release of Rails. This version also has a much more organized Contents section that has a folder group for each gem, which will hopefully lead to easier browsing of the entire file. You can download this release from this url.
If after downloading the file you find that you can’t view pages in the document, Windows Security is probably to blame (complaining about the file originating from another computer). To fix this problem, simply right-click on the downloaded file, select Properties and click the Unblock button at the bottom of the window.
Also, if you’re one of the hip kids using Rails trunk, keep an eye out for a pre-release of the 1.2 documentation later this week. With all the new items in Rails trunk (ActionService, simply restful, etc) I’ve found myself needing to scan the source files from time to time (interesting, but time consuming).
I was able to get around to updating the Rails CHM Documentation this morning. It’s taken me a bit longer than I would have liked to get this out, so I apologize. There really is a good reason for the long wait!
I had previous made some modifications to the RDOC CHM generator file to get the previous version working the way I liked, and while upgrading Ruby to 1.8.4, I accidentally overwrote the file (oops). Because of this, I had to go back and make the modifications again, and I really hadn’t been motivated to do this since I was busy with other projects. This morning, I sat down and decided to get the file out. I made backup copies of these files this time, so this shouldn’t happen again.
For those wondering, I am still planning on getting an article out detailing exactly what I do to generate this CHM file (including the RAKE task). Until that happens though, you’ll just have to live with the file I’ve got. :-)
Here’s the url: http://delynnberry.com/pages/rails-chm-documentation.
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.
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!
