Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

voyant_mt_app.pl File Reference

Creates table of contents navigation to be displayed in the navigation pane. More...

Go to the source code of this file.

Defines

Functions

Variables


Detailed Description

Creates table of contents navigation to be displayed in the navigation pane.

Parameters:
globe::path  is the directory_name or location to find the tree script files. The name should be terminated with a slash (\). Although the directory_name is the first command line parameter, the true input are the tree script files contained within that directory. Tree script files must begin with "tree_" and end with ".script".
globe::master_filename  [optional path and] filename for the project file that contains the directory ordering and official titles.
Returns:
m_tree_ files for each directory of the system. The files are named such that they are associated with their owning directory.
Tree script files are another way of saying "Table of Contents" files. Tree files themselves are mini-TOC files that were generated by voyant_nav.pl or tree_js_2_script.pl.

This program reads in the project file (master_filename). Based on the directory names, it makes some assumptions about the names of the tree script files that it expects to see. It steps through all tree script files, reads them in, creates associated master tree script files, and then creates a master tree script file that nests the other tree script files in order.

If an expected tree script file is missing, an error message is output but a working master tree is still generated that ignores the missing mini-TOC.

Note:
When the original tree script files were created, they had no path information in the hyperlinks. This was to make them more general and more easy to use in other directory structures. The tree script files needed to stand on their own and be independent of any resulting directory structure where they might be shared.
Hence, this program must create master script files that include the expect relative paths to the destination topics. The relative path information is again the directory names from the project file.
Limitations and Caveats:
The tree files (mini-TOC) that are used as input have unique naming requirements. Rather than passing in variables which can create copies in memory, many items use global variables that are defined in globe.pm. When a variable is known to be global, its name begins with "$globe::". The intent is to facilitate maintenance by having all user-defined tags in one place outside of the program.
Author:
Glenn C. Maxey

Definition in file voyant_mt_app.pl.


Define Documentation

#define holder
 

#define key   ""
 

#define key   ""
 

#define master_script   ""
 

master_script   ""
 

Definition at line 520 of file voyant_mt_app.pl.

#define out_file   ""
 

out_file   ""
 

Definition at line 530 of file voyant_mt_app.pl.

#define section
 

#define section
 

#define temp_file_buf   ""
 

#define temp_file_buf   ""
 


Function Documentation

int BEGIN  
 

Definition at line 142 of file voyant_mt_app.pl.

int END  
 

Definition at line 689 of file voyant_mt_app.pl.

if  
 

Definition at line 521 of file voyant_mt_app.pl.

if open(OUT_MNAV,">$globe::path$out_file")   
 

Definition at line 375 of file voyant_mt_app.pl.

if   nested_scripts = ~ /master/
 

Definition at line 286 of file voyant_mt_app.pl.

if   ARGV,
  _arg_inc
 

Definition at line 205 of file voyant_mt_app.pl.

unless open(OUT_MNAV,">$globe::path$out_file")   
 

Definition at line 532 of file voyant_mt_app.pl.


Variable Documentation

_arg_inc
 

Definition at line 224 of file voyant_mt_app.pl.



 "Perl Program Reference" 
 < Previous 
 Next > 



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

TP Tools v2-00-0a

# tpt-perl-hcr-02