10.4.2 Creating a search index for JavaHelp
JavaHelp utility program JHIndexer creates a search index for JavaHelp, and places the search index in a subfolder called JavaHelpSearch. You can have Mif2Go run JHIndexer, or you can run it yourself. In addition to creating a search index, you must also provide a link to the search index from the helpset file; see §10.4.1 Including a search-index link in the helpset file.
To have Mif2Go automatically run JHIndexer:
; FTSCommand = for Sun Java Help, path to jhindexer, such as:
FTSCommand = D:/jh2.0_01/jh2.0/javahelp/bin/jhindexer
The value of FTSCommand must include an absolute path to the folder where the JHIndexer program is installed on your system. If the path includes spaces, you must enclose it in double quotes. For example:
FTSCommand = "G:/JH/jh2.0 01/jh2 0/javahelp/bin/jhindexer"
Note:
Do not enclose parameters in quotes.
Use backslashes as separators in path-name parameters.
Use a dash ("-") instead of a forward
slash to prefix a command option.
When you specify a value for FTSCommand, after generating output files for JavaHelp, Mif2Go first removes any search-index folder previously created by JHIndexer, then uses the command to run JHIndexer and produce a new search index.
If you also specify a value for [Automation]WrapPath, Mif2Go copies all needed files from the project folder to the JavaHelp folder structure before running JHIndexer; see §10.2.7.2 Letting Mif2Go set up the folder structure and copy files.
If you do not specify a value for FTSCommand, you must run JHIndexer yourself, from the folder where your helpset file is located, and specify the folder where the HTML files are located. For example, at a Windows command prompt:
path\to\JavaHelp\files\bin\jhindexer html
If you are using a folder structure such as the following for your project, run JHIndexer from the Help folder:
....Help (JHM, HS, TOC, Index; run JHIndexer from this folder)
Your structure ends up looking like this:
....Help (JHM, HS, TOC, Index)
......JavaHelpSearch (Created by JHIndexer)
It is best to remove any previous search-index folder before you run JHIndexer to create a new folder. If a previous attempt to create a search index failed, further attempts will also fail if the failed search-index folder is present.
You must run JHIndexer from the folder where the helpset file is located. If you try to run JHIndexer from within the HTML folder, JHIndexer will put the JavaHelpSearch folder inside the HTML folder. If you try to run it from any other folder, you get strange effects in the Contents panel.
§6.2.4 Compiling and distributing Help systems
§10.2.7.2 Letting Mif2Go set up the folder structure and copy files
§10.2.7.5 Specifying a path for search-index links
§10.4.1 Including a search-index link in the helpset file
> 10 Generating JavaHelp or Oracle Help > 10.4 Providing full-text search for JavaHelp / Oracle Help > 10.4.2 Creating a search index for JavaHelp