How does the Help Generator work?

The Help Generator is presented as a wizard. In this WYSIWYG wizard you can place settings as where to store files, CSS, adding hotspots yes or no etcetera. The effect of your choices is immediately visible on the right side of the window. That way you can control exactly what the generated help will look like. On the Contents tab you will find the contents tree. With right-clicking on the tree you can change the order of topics or exclude topics to be generated. The following items are prepared:

  • HTML Help files and screenshots for each topic in your application,
  • the HelpContextId property for each processed form is set,
  • all project files (including table of contents and index) are created,
  • links from the help file to your application.

help generator wizardThis makes the Help Generator a time-saving help authoring tool both for technical writers and programmers. The Generator scans the application. Each form in your application is analyzed in detail in terms of controls, menu, tab order etcetera and presented as pages with well-formed HTML. In the Microsoft Access version other application objects are additionally processed: reports, tables, relations and queries.

Help Generator: generates all help files and links them to your application:

General
htm Topic pages
bmp/jpg Images
HTML Help
hhp HTML Help Project File
hhc Help Contents file, contents tree
hhk Help Index file relating keywords to topic pages
h Mapping between topic pages and HelpContextIds
Web based help
hhc Help Contents file, web version
hhk Help Index file, web version
Help Generator
hgp help generator project
xml scanned object description
HTML Help linking to the application
HelpFile and HelpContextId properties