Quick Start |
 |
The simplest way to create a new project is by using the wizard which automatically pops up when a new project is created, however, if you wish to create your project manually then the following steps will guide you through the process:
· Create help project element
Represents help project. Contains parameters required to create output help file.
Note: The fastest way to create the structure for your help file is to import and parse your source files. If you choose not to use this approach then continue with the following steps:
· Create at least one package element
Represents Delphi component package file or, if there no package file, it is an entity for grouping units together. At least one package is required to create descending units.
· Create unit elements
Represents Delphi unit file. May include code examples and "See Also" cross-links.
· Create object elements
Represents class, object or component. Contains links to open hierarchy window and list of class member window. May include code examples and "See Also" cross-links. Hierarchy window shows every ancestor of the component in the component hierarchy based on the current project data and VCL selected.
· Create property elements
Represents class property. May include code examples and "See Also" cross-links.
· Create method elements
Represents class method (constructor, destructor, function or procedure). May include code examples and "See Also" cross-links.
· Create event elements
Represents event - class property of procedure type. May include code examples and "See Also" cross-links.
· Create function or procedure elements
Represents any function or procedure defined in a unit. May include code examples and "See Also" cross-links.
To create a structure of your help project complete the following steps:
· Enter topic and description text for each element where it is required
· Create help file and table of contents
· Set color and font
· Import and Export
Help project can be saved into file as XML. Use project saved in XML format to backup the data, exchange projects between workstations where Source Help Builder installed, to publish the help generated as HTML document by creating your own XLST.
By this stage you will have completed the creation of your .hlp and .cnt files which may be supplied for distribution with your components / packages.
See also:
How to include the help file into Delphi IDE help system? |
