Contents 
 Index 
 "Perl Program Reference" 
 < Previous 
 Next > 

Table of Contents Tool

Generates master tree files from previously generated tree files to get master table of contents. More...

Files

Functions


Detailed Description

Generates master tree files from previously generated tree files to get master table of contents.


Function Documentation

int creating_book_toc  
 

Reads in the tree file associated with the master order of a book and creates the table of contents section for it.

Parameters:
Varables  defines aboved.
IN_HTREE  files that were generated from the voyant_nav.pl program. Moreover, these are expected to begin with "tree_" and then contain the path of where they came from.
Return values:
section  is a fully formatted and tagged section that can be placed directly into a template.
This is the old way called by create_master_tree_script, which itself is no longer called.

This was originally part of the TIORDER loop above and still uses variables as if still above. It was broken out to provide more clarity particularly when adding collapsing/expanding chapters for a book.

Bug:
This uses not only globe variables, but also define variables defined in create_master_tree_script. This expects the tree_...html files contain the path as part of the name.

Definition at line 572 of file voyant_mt_app.pl.

int get_tag_chunk  
 

Gets the information between two tags.

Parameters:
input_chunk  Text to parse for tags.
start_flag  starting tag to look for.
end_flag  ending flag to look for.
critical  specifies whether or not to record error messages.
Return values:
before  the information before the starting tag, 0 if one of tags is missing.
info  the information between the tags, 0 if one of tags is missing.
after  the information after the ending tag, 0 if one of tags is missing.
Limitations and Caveats:
Does not return the tags.

Definition at line 738 of file globe.pm.

Referenced by _arg_inc().

int replace_tag_chunk  
 

Replaces the information in between the tags with the supplied information.

Parameters:
input_chunk  Text to parse for tags.
start_flag  starting tag to look for.
end_flag  ending flag to look for.
replacement_text  Text to put between tags.
reinsert_tags  specifies whether or not tags should be reinserted
critical  specifies whether or not to record error messages.
Return values:
success  1 if found tags, 0 if one of tags is missing.
output  with replacement text and tags if found tags, the original input text if one of tags is missing.
Limitations and Caveats:
None.

Definition at line 820 of file globe.pm.

int script_output  
 

Breaks up the book tree files into even smaller chapter tree files.

Parameters:
global_variables 
Returns:
Returns a series of HTML files that represent the expanding/collapsing of chapters within a book.
This is the old way called by create_master_tree_script, which itself is no longer called.

It handles the naming and the writing of all tree navigation files. It changes icons where appropriate.

The entire mini-TOC for the book was already available. This accomplishes the task of creating chapter chunks that expand/collapse by stripping all the topics from other chapters except the top level. The top level is left, but changes its icon to be a closed book and changes the hyperlink to point to the appropriate master tree file associated with that chapter.

Limitations and Caveats:
Upon entering, it is known that this is a book file. In fact, the entire mini-TOC for that book is already available.

Definition at line 630 of file voyant_mt_app.pl.

int using_voy_mt_app  
 

What to do when no arguments are given.

Parameters:
None 
Returns:
None
Limitations and Caveats:
None

Definition at line 656 of file voyant_mt_app.pl.

Referenced by _arg_inc().



 "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