Contents 
 Index 
 "Shell Script Reference" 
 < Previous 
 Next > 

55_nav_gen.b File Reference

Creates the mini-TOC and mini-index navigation files for the specified project using information extracted from two input files. More...

Go to the source code of this file.


Detailed Description

Creates the mini-TOC and mini-index navigation files for the specified project using information extracted from two input files.

Parameters:
nav_path  The starting location to look for subdirectories. Generally, this is "doc_publish/". It was broken out of the full path, because the sim_name parameter was needed for other purposes.
sim_name  The simplified name of the destination project. This parameter is used to locate both the source HTML files (as in <nav_path><sim_name> but also to name generated mini-index and mini-TOC files appropriately for the project.
master_nav  The name of an master HTML file that has common HTML fragments which are to be inserted in all generated HTML pages.
master_proj  The name of the project_toc.txt file that defines all directories and their associated names, pdf files, and document numbers.
This calls the voyant_nav.pl perl program. It processes the files specified in the <nav_path><sim_name> directory. It requires the master_nav file and the master_proj file.

The master_nav file is an HTML file that contain tags which are to be placed in every single HTML file in the directory.

The voyant_nav.pl perl program generates a mini-index and mini-TOC file. When finished, this script needs to copy them to a known location for subsequent processing. It must name them uniquely for the project, which is why the <sim_name> is required to be broken out.

In addition, getting individual project directories updated with the latest CSS was error prone. This handles it while processing, so that it doesn't get forgotten.

Author:
Glenn C. Maxey

Definition in file 55_nav_gen.b.

 "Shell Script Reference" 
 < Previous 
 Next > 



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

TP Tools v2-00-0a

# tpt-script-hcr-02