Contents 
 Index 
 "TPT User's Guide" 
 < Previous 
 Next > 

56_nav_index.b

This script performs several operations needed to prepare and finalize the index for the HTML system.

• It removes any leftover index files or master index files from the temporary directory (zdoc_merge).

• It removes any master index files from the final directory (doc_publish).

• It copies default master index files to the temporary directory (zdoc_merge). The default files state that the letter has no entries and when appropriate are overwritten by voyant_indexer.pl.

• It copies from the directories of the system all index files that were generated by voyant_nav.pl and gives them unique names in the temporary directory (zdoc_merge).

• Runs voyant_indexer.pl to create new master index files in the temporary directory.

• Copies all master index files from the temporary directory (zdoc_merge) to the final directory (doc_publish).

A single template file is specified on the command line to voyant_indexer.pl and is used to generate the master index files. However, voyant_indexer.pl only generates index files for letters that it encounters. This can leave holes in the index navigation. Hence, the suite of index files is first populated with defaults for all letters using the cp command and the template file.

Refer to the documentation for voyant_indexer.pl to find out all that this script accomplishes in the index that is generated.



 "TPT User's Guide" 
 < Previous 
 Next > 


Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003

TP Tools v2-00-0a

# tpt-hug-02