When deploying the module project, you can also deploy a help documentation that the user can refer to. You can give the basic description of components and explain how to use properties, methods, and events.
The current version only supports help documentation in the CHM (Compiled HTML) file format. In this chapter, we will look at how to create and deploy help documentation in the CHM file format.
Installing HTML Help Workshop
There are several tools that can generate the CHM file. Among them, the HTML Help Workshop is provided free of charge and it lets you generate the CHM file easily.
1
Access the link below.
https://www.microsoft.com/en-us/download/details.aspx?id=21138
2
Click the [Download] button, select the "htmlhelp.exe" file from the list of files, and click the [Next] button.
3
Download the htmlhelp.exe file.
4
Run the downloaded htmlhelp.exe file to install HTML Help Workshop.
5
Check and run the HTML Help Workshop in the list of apps.
Generating Simple CHM File
You can set various things, such as a table of contents and index, in the CHM file, but in this example, we will generate the CHM file with only one page.
1
Generate the HTML file first in the location to generate the project.
Configure the HTML file simply using the PRE tag and save as Help.htm.
<html> <body> <pre> SIMPLE MODULE - TwoMonthCalendar </pre> </body>
2
Run HTML Help Workshop.
3
Select [File > New] item from the menu and select [Project] for the type to be generated.
4
Specify the project file path without checking anything else in the Project Wizard.
When the project is generated, basic information is displayed on the Project tab.
5
Select the Contents tab and add content.
When you select the Contents tab, it will ask if you want to generate a new hhc file. With the [Create a new contents file] item selected, click the [OK] button.
6
Select [insert a page] item from the right toolbar.
7
Enter "SIMPLE MODULE" in the Entry title item and click the [Add] button to display a window for selecting a file. Click the [Browse] button and select the Help.htm file generated earlier.
8
Check that the list of pages added in the Contents tab is displayed.
9
Select the Project tab and select [Change project options] item from the right toolbar.
10
Enter the Title item in the Options window and enter the Help.htm file in the Default file item.
11
Select [File > Compile] item from the menu to generate the CHM file.
If there is no file specified when generating the CHM file, an error message is displayed.
12
Run the generated CHM file to check if the content is displayed normally.
Adding Help to Module Project
1
On the Project Explorer tab, select the language (CHN, ENG, JPN, KOR) folder under the Help item, and select the [Import Help Files] item from the context menu.
2
Select and add the CHM file. You can add the CHM file for the selected language folder.
Depending on the language set in the operating system, for Chinese, Japanese and Korean, run the CHM file under the corresponding folder, and for other languages, run the file under the ENG folder.
3
Install the module in Nexacro Studio. You can check the added help in the menu [Help > Help].
4
After placing the composite component on the Form screen, select the component and press the F1 shortcut key to run the module help.