TLB to HLP
TLB to HTML
TLB Compare
Oberon Type Library Tools
For general information on Oberon Type Library Tools utility, return it its home page.
TLB2HLP
To start this tool, just click Create WinHelp File... button in the main window. It will bring up the TLB2HLP window:
Type Library - a source file for type library information.
RTF File - a full path and name of the main help topic file. The other help project files (.cnt, .inc, .prj, etc) will be created in the same folder as the .rtf file specified.
Use Topic Reference substitution file - check if you want to specify help topic substitution file for the help index (see below).
Substitution File - A text file that contains alternative help topics file to be used in generation of the CNT file. The text file should be in the following format:
ClassName1,HelpTopic1
ClassName2.MethodName,HelpTopic2
For example:
Clipboard,IDH_NewClipboard
Clipboard.Clear,IDH_NewClipboard_Clear
You will not normally use this feature anyway.
Index Limit - when there are too many objects or methods/properties, TLB2HLP can group them to make navigation through the help index easier:
 |
 |
| Normal index | Grouped index |
The two numbers in the dialog specify the number of items the index must have before the items are grouped. If the number of items is less then the higher limit, then the items are not grouped at all. If it is greater than the higher limit, then the index items are grouped into clusters containing no more than the lower limit number per group.
Launch MS Help Workshop on Completion - when checked Microsoft Help Workshop is invoked and the generated help project is opened automatically. You must have MS Help Workshop installed and associated with .prj file extension.
The resulting help context file contains the following entries:
- Getting Started - with a single entry topic you can use to provide introduction information
- Object Model Reference - contains the whole object model description divided into subsections:
Object Model References section has the following sub-sections (provided the object model has the corresponding objects defined):
- Classes - the list of all classes (coclass, interface,
dispinterface). Each class entry has a main help topic reference and
the following subsections:
- Properties
- Methods
- Events
- Constants
- Modules - all modules defined in the type library. Each
module can have the following subcategories:
- Properties
- Methods
- Events
- Constants
- Types - all types defined in the type library
- Unions - all unions defined in the type library
- Enums - all enumerations
- Properties - all properties of all objects and modules
- Methods - all methods of all objects and modules
- Events - all events of all objects
- Constants - all constants defined in modules and enumerations
Class and module description help page contains an additional window that lists all properties, methods and events of the class or module for easier access. This help topic also have "Referenced By" link that shows all the methods, properties and events that use or return the given class as a parameter:
Each help topic in the generated help file uses object item description to provide a starting point for future more detailed content:
If you choose a property, method, event or constant from the help contents window and the item appears in more than one class, module or enumeration, a separate page that list all such occurrences is automatically created:
Enumerations also show description for each element if the information is available in the type library:
All of the above screenshots were taken from the help file generated automatically by TLB Tools from Visual Basic 6 run-time library without any further editing of the help file.
You can download a sample help file generated by TLB Tools and compiled with the Help Workshop here:
- vbrun.zip (73 K). Contains compiled help file (vbrun.hlp, vbrun.cnt).
Click here to return to TLB Tools home page.