- Inheritance
- < Generators::HTMLGenerator < Object
Constants
| Name | Description | |
|---|---|---|
| HHC_PATH | = "c:/Program Files/HTML Help Workshop/hhc.exe" |
Methods
Class
| Visibility | Signature |
|---|---|
| public | for (options) |
| public | new (*args) |
Instance
| Visibility | Signature |
|---|---|
| public | check_for_html_help_workshop () |
| public | compile_project () |
| public | create_contents_and_index () |
| public | create_help_project () |
| public | create_project_file () |
| public | generate (info) |
Class Method Detail
for(options)
Standard generator factory
new(*args)
Instance Method Detail
check_for_html_help_workshop()
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