How help topic material is processed

Depending on how much metadata is supplied for a topic or book, the ODSSI tools perform the following actions (see ``Processing man section tables of contents'' for information on how man sections are processed).

If a .node file is present

1. Combine all .node files in the directory.

2. Select records based on status and version number.

   If Status is ``delete'', do not include the node. If records for more than one version exist, use the version with the highest number. The result of this process is a list of active nodes.

3. Make sure the HTML files for each active node exist.

4. Write the active records to a bookid.titles file. This file is regenerated as needed based on the collection of installed documentation.

5. Generate a bulk insert file for the Verity search engine.

6. Run the bulk insert process to update the search indexes.

If a .book file is present

If the TOCType is:

fixed

This assumes the table of contents is not to be regenerated. The tools:

1. Check for the specified TOCFilename. If present, create a symbolic link to CONTENTS.html.

2. If not present, flag as an error and generate an alphabetical index.

chapter

1. Check for a .node file. If it exists, check for records with ChapterTOCWeight values, which are chapter table of contents nodes. If both conditions are not satisfied, then generate an alphabetical table of contents.

2. Collect all records from the bookid.titles file that have a field for ChapterTOCWeight.

3. If only one such record exists, do not generate a table of contents. Instead, create a symlink to CONTENTS.html.

4. If more than one record exists, sort by ChapterTOCWeight (lower numbers first).

5. If the .book file contains a field for TOCFilename, generate the table of contents in that file and link it to CONTENTS.html. If not specified, generate CONTENTS.html.

   ---

   NOTE: The individual chapter tables of contents are not regenerated, only the list of chapters is.

   ---

alpha

1. From the list of active nodes in bookid.titles, sort by title.

2. Generate the table of contents HTML as above.

3. If TOCFilename value is there, write the HTML to the specified filename and create a symbolic link to CONTENTS.html. Otherwise, create CONTENTS.html.

If neither .node file or .book file is present

1. If a file named index.html exists, create a symbolic link to CONTENTS.html.

2. If no index.html exists, scan the set of HTML files included in the directory. If files are compressed, use zcat(1) to read them.

3. Create a bookid.titles file, using the node name and the <TITLE> element for each .html file.

4. Generate an alphabetical table of contents based on the <TITLE> elements in the .html files.

5. Create a basic Verity bulk insert file based on just the files and titles.

6. Run the bulk insert process to update the search indexes.