System information

Using helpTool

Page 184 Identity Manager 7.1 Update 1 • Release Notes

Rebuilding/Re-Creating the Documentation Index

Use the following procedure to rebuild or re-create the documentation index:

1. Unpack the helpTool distribution to a temporary directory. (Details TBD)

In this example, we will extract the files to

/tmp/helpTool

2. In a UNIX shell or Windows command window, change directory to the location where the

Identity Manager application was deployed to your web container.

For example, a directory for Sun Java System Application Server might look like:

/opt/SUNWappserver/domains/domain1/applications/j2ee-modules/idm

3. Change your current working directory to the

help/

directory.

4. Gather the following information for your command line arguments:

❍ Destination directory —

html/docs

❍ Input files —

../doc/HTML/en_US

❍ Nova index directory —

index/docs

❍ Output file name —

index_files_docs.txt

❍ Indexing properties file —

index/index.properties

NOTE You must run helpTool from this directory or the index will not build

correctly. In addition you should remove the old index files by deleting the

contents of the

index/docs/

subdirectory.

NOTE The tool will copy the en_US/ directory and subdirectories to the

destination.

NOTE The name of the file is not important – but the tool will exit if this file

already exists.