|
|
|
|
|
The voyant_master_nav.html file is a template file that is used by the voyant_nav.pl program. Its intend is to facilitate standardized look-and-feel, navigation, and copyright information across all HTML files that are in a documentation system.
The TechPubTools employ standard HTML comments that reside in the HTML file but are not displayed by the browser. The comments are typically used as pairs (begin and end) and contain a tag name that TechPubTools recognize.
The voyant_master_nav.html defines master information for all HTML files in sub-projects directory or even for the entire HTML system. The information residing between the paired comment tags in the master file gets propagated into all HTML files in between their respective comment tags.
The voyant_master_nav.html can be used as a template to define your own master file. The name of the file is not important. The 55_nav_gen.b shell script makes calls to the voyant_nav.pl program and passes in whatever master file you specify.
Presently, the voyant_master_nav.html defines:
the cascading style sheet information in addition to hyperlink colors.
the common navigation that all HTML files should have. This is implemented as fake-button through nested HTML tables. This was chosen because at the time, appropriate GIF images for the buttons were not available. It was also believed that the tables would load fast.
the navigation that Doxygen generated files should have. This uses nested HTML tables for fake-buttons.
the navigation that Mif2Go generated files should have. These are files that come from FrameMaker and are meant to be browsed. This uses nested HTML tables for fake-buttons.
the copyright information that is displayed at the bottom of each topic.
additional parameters for the Java TOC Applet which allow the topic to be tracked in the table of contents when using the browse buttons (and assuming the book for the topic has already been expanded to at least its first level.)
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02