Class Generator::CHM
In: lib/rdoc/generator/chm.rb
Parent: RDoc::Generator::HTML

Methods

check_for_html_help_workshop   compile_project   create_contents_and_index   create_help_project   create_project_file   for   generate   new  

Classes and Modules

Module Generator::CHM::CHM

Constants

HHC_PATH = "c:/Program Files/HTML Help Workshop/hhc.exe"

Public Class methods

for(options)

Standard generator factory

Public Instance methods

compile_project()

Invoke the windows help compiler to compiler the project

create_contents_and_index()

The contents is a list of all files and modules. For each we include as sub-entries the list of methods they contain. As we build the contents we also build an index file

create_help_project()

The project contains the project file, a table of contents and an index

create_project_file()

The project file links together all the various files that go to make up the help.

generate(info)

Generate the html as normal, then wrap it in a help project

[Validate]

ruby-doc.org is a service of James Britt and Rising Tide Software, a Ruby application development company in Phoenix, AZ.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.