# Rails app -\> CHM file?

**URL:** <https://www.ruby-forum.com/t/rails-app-chm-file/191638>\
**Category:** Rails\
**Created:** [July 15, 2010, 5:54pm UTC](https://www.ruby-forum.com/t/rails-app-chm-file/191638 "2010-07-15T17:54:45Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![rpardee](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e47c2d/32.png) [@rpardee](https://www.ruby-forum.com/u/rpardee)\
**Post date:** [July 15, 2010, 5:54pm UTC](https://www.ruby-forum.com/t/rails-app-chm-file/191638/1 "2010-07-15T17:54:45Z")

</div>

Hey All,

I’ve got an app that stores infrequently-changing-but-not-entirely-  
static data. I’d like to be able to generate a snapshot of the app  
(or a portion thereof) in a CHM file so users can snag a copy for  
offline use, that still has the hyperlink structure intact, can be  
searched, printed, etc. Optimal would be something I could feed a  
route to & it would spider every link from there, using my existing  
views.

My googling has not turned up any existing gems/plugins that just  
magically do what I want, alas, but I wondered if anybody here can  
point me at a likely place to start on such a feature? I know there’s  
an rdoc plugin or branch that generates CHM from rdoc–that’ll be  
where I start unless someone has a better suggestion.

Many thanks!

-Roy

---

<div class="post-metadata">

**Author:** ![rpardee](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e47c2d/32.png) [@rpardee](https://www.ruby-forum.com/u/rpardee)\
**Post date:** [July 15, 2010, 6:44pm UTC](https://www.ruby-forum.com/t/rails-app-chm-file/191638/2 "2010-07-15T18:44:31Z")

</div>

On 15 Jul 2010, at 17:53, Roy P. wrote:

> point me at a likely place to start on such a feature? I know there’s  
> an rdoc plugin or branch that generates CHM from rdoc–that’ll be  
> where I start unless someone has a better suggestion.

If you are on OS X, you can use the rdoc\_osx\_dictionary (more info  
here: [GitHub - seattlerb/rdoc\_osx\_dictionary](http://github.com/seattlerb/rdoc_osx_dictionary)). I believe  
there’s a dependency on hoe that isn’t installed with the gem  
(although it should be, but it isn’t), so if you are having problems,  
make sure you have hoe installed too.

A google search for “rails chm” brought up these:

> **[Ruby Core & Ruby on Rails CHM Documentation](https://moiristo.wordpress.com/2008/08/28/ruby-core-ruby-on-rails-chm-documentation/)**
>
> Today, my company’s internet provider managed to cut off the internet connection for the whole day! This made me wonder why I always use the online available Ruby & RoR APIs, while having…

[http://dirk.net/2007/12/30/generate-ruby-on-rails-chm-documentation/](http://dirk.net/2007/12/30/generate-ruby-on-rails-chm-documentation/)  
etc.

Maybe you’ll have luck with those links.

Best regards

Peter De Berdt

---

<div class="post-metadata">

**Author:** ![rpardee](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e47c2d/32.png) [@rpardee](https://www.ruby-forum.com/u/rpardee)\
**Post date:** [July 15, 2010, 8:07pm UTC](https://www.ruby-forum.com/t/rails-app-chm-file/191638/3 "2010-07-15T20:07:40Z")

</div>

On 15 Jul 2010, at 19:25, Roy P. wrote:

> Thanks Peter. I’m looking for cross-platform output, so I don’t think  
> the apple dictionary format will serve. I think those links tap into  
> the rdoc stuff, but I’ll give them a read & see.

Misread your original post a bit. You’ll probably have to look into  
CHM generation from rdoc and then roll your own as you already  
suggested.

Best regards

Peter De Berdt

---

<div class="post-metadata">

**Author:** ![rpardee](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e47c2d/32.png) [@rpardee](https://www.ruby-forum.com/u/rpardee)\
**Post date:** [July 15, 2010, 7:30pm UTC](https://www.ruby-forum.com/t/rails-app-chm-file/191638/4 "2010-07-15T19:30:11Z")

</div>

On Jul 15, 9:42 am, Peter De Berdt [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> > My googling has not turned up any existing gems/plugins that just
> 
> A google search for “rails chm” brought up these:
> 
> [http://moiristo.wordpress.com/2008/08/28/ruby-core-ruby-on-rails-chm-...http://dirk.net/2007/12/30/generate-ruby-on-rails-chm-documentation/](http://moiristo.wordpress.com/2008/08/28/ruby-core-ruby-on-rails-chm-...http://dirk.net/2007/12/30/generate-ruby-on-rails-chm-documentation/)  
> etc.
> 
> Maybe you’ll have luck with those links.
> 
> Best regards
> 
> Peter De Berdt

Thanks Peter. I’m looking for cross-platform output, so I don’t think  
the apple dictionary format will serve. I think those links tap into  
the rdoc stuff, but I’ll give them a read & see.

Thanks!

-Roy
