Class RDoc::Generator::CHM
In: lib/rdoc/generator/chm.rb
Parent: RDoc::Generator::HTML
CodeObject Include Context Alias Attr AnyMethod Constant Require ClassModule NormalModule SingleClass AnonClass NormalClass TopLevel RubyParser RubyToken RuntimeError Error Error AttributeFormatter AnsiFormatter OverstrikeFormatter HtmlFormatter DefaultDisplay NamedThing IncludedModule Attribute Constant MethodSummary AliasName ClassEntry TopLevelEntry Description MethodDescription ModuleDescription ClassDescription Formatter SimpleFormatter HTML HTMLInOne XML CHM Context Method Class File Element Edge Node Subgraph Digraph SimpleElement Port Options Diagram Fortran95parser RDoc SimpleParser Token Markup TemplatePage Stats C_Parser NameDescriptor Cache Reader Writer Driver MethodEntry RI AllReferences Display Paths RI MarkUp Generator TokenStream ParserFactory DOT RDoc dot/f_4.png

Methods

check_for_html_help_workshop   compile_project   create_contents_and_index   create_help_project   create_project_file   for   generate   new  

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]