This stage allows to select various options controlling the output generated by Document! VB.
Destination
Either type in an existing path and required output filename, or press the 'Browse' button to identify the required output path and file name.
Write context sensitive Help IDs to source code
This option will do 3 things
- Make sure that each Method, Property and Component in your source code has a Help Context ID, generating a new unique one if it does not;
- Associates the Help Context IDs with the relevant topic in the generated HTML Help File;
- Updates the VB Projects 'Help File' property to invoke the correct Help file when a user of your software invokes context sensitive help (presses F1) when the cursor is over one of your components, Methods or Properties or when in the VB Object Browser.
This feature is extremely powerful as it allows users of your software to get instant access to the topic they are interested in without having to search through complex index or table of contents lists.
For further information on Document! VBs context sensitive help feature, refer to Creating context sensitive help.
IMPORTANT If you are developing using Visual Basic 5 and / or the software you are producing context sensitive HTML help for will be used by Visual Basic 5 users please refer to the 'Providing HTML Help based context sensitive help in Visual Basic 5' topic.
Write Help Descriptions
This option allows you to write back comments extracted from your source code as Help Descriptions that will appear associated with a method, property or component when a user of your software uses a tool such as the VB Object Browser.
Compile Help File
You may not (for whatever reason) require Document! VB to automatically compile the HTML Help file for you. Removing the check from this box prevents HTML Help file compilation.
Always show HTML Help compiler output
By default, the output from the HTML Help compiler is only displayed if an Error or a Warning was issued. If you wish to always see the compiler messages, check this box.
Display HTML Help file after output
Check this box to display the generated HTML file after it has been successfully created.
WinHelp Support
The 2 Winhelp support options allow you to create and optionally compile a Winhelp file that will allow context sensistive HTML Help to be used by Visual Basic 5 users.
You do not need to check either of the Winhelp support check boxes unless you intend to provide the Document! VB produced HTML Help to Visual Basic 5 users. For more information please see the 'Providing HTML Help based context sensitive help in Visual Basic 5' topic.