This chapter describes the text search indexer, and how to use it to generate index files
This topic contains the following sections:
A Java-based text search indexer is included with Oracle Help for Java. The indexer generates the .idx
files used for text searches within Oracle Help. Two versions of the Text Search Indexer are provided, one for Japanese content and another for non-Japanese content.
The Text Search Indexer requires Java5 Standard Edition or later. Performance is greatly enhanced if you leave the Java JIT (Just In Time Compiler) on. Also ensure that you increase the heap size of the Java Virtual Machine to maximum.
Follow these steps to run the indexer:
Include the OHJ Indexer JAR file help
indexer-version
.jar
in your CLASSPATH.
Run the indexer from the command prompt. The indexer supports the following command-line arguments:
[-l=locale] [-e=charset] dirnameindexfilename
where,
Argument | Description |
---|---|
|
The optional (but recommended) |
|
The optional (but recommended) charset parameter is the name of the Java-supported character set encoding for the HTML files that are being indexed. If the encoding is not supplied, the default character set encoding of the current system default locale is used. If supplied, the value must be a Java supported character set encoding names; for Java SE, see |
|
The base directory that contains the HTML files you want to index. The indexer indexes all of the files under this directory (and its subdirectories, if any). |
|
The name of the index file to be generated. |
For example, java -mx64m oracle.help.tools.index.Indexer -l=en_US -e=8859_1 D:\MyHTMLFiles myIndex.idx
The above command sets the Locale to language: English, country: Unites States, encoding: 8859_1
, and indexes the D:\MyHTMLFiles
directory creating the myIndex.idx
file.
Follow these steps to run the indexer:
Include the OHJ Indexer JAR file help
indexer-version
.jar
in your CLASSPATH.
Run the indexer from the command prompt. The indexer supports the following command-line arguments:
[-e=charset] dirnameindexfilename
where,
Argument | Description |
---|---|
|
The optional (but recommended) charset parameter is the name of the Java-supported character set encoding for the HTML files that are being indexed. If the encoding is not supplied, the default character set encoding of the current system default locale is used. If supplied, the value must be a Java supported character set encoding names; for Java SE, see |
|
The base directory that contains the HTML files you want to index. The indexer indexes all of the files under this directory (and its subdirectories, if any). |
|
The name of the index file to be generated. |
For example,java -mx64m oracle.help.tools.index.JapaneseIndexer -e=MS932 D:\MyHTMLFiles myIndex.idx
The above command runs the JapaneseIndexer with the encoding set to MS932
, and indexes the D:\MyHTMLFiles
directory, creating the myIndex.idx
file.