|
|
|
|
|
The voyant_master_index.html file is used by the voyant_indexer.pl program to create a series of tree files that represent the table of contents navigation of the HTML system.
More so than the voyant_master_nav.html file, the voyant_master_index.html file is intended to be used over and over as a template.
The TechPubTools employ standard HTML comments that reside in the HTML file but are not displayed by the browser. The comments are used as pairs (begin and end) and contain a tag name that TechPubTools recognize.
The voyant_master_index.html can be used as a template to define your own master file. The name of the file is not important. The 56_nav_index.b shell script makes calls to the voyant_indexer.pl program and passes in whatever master file you specify.
Presently, the voyant_master_index.html defines:
the cascading style sheet information in addition to hyperlink colors.
the outline of the structure to be used for all navigation pages.
the links to other pages of the navigation. This can include fake-buttons at the top and bottom to the Contents, Index, and Full-Text Search.
Together with the _start_here.html file, a dual pane navigation system is created. The series of m_idx files that are generated based on this template file are meant to be displayed in the target=treefrm. The contents that they control are meant to be displayed in the target=basefrm.
Your master files are required to have a certain comment tags defined. Your master file has to be a functional HTML file with the proper <html>, <head>, and <body> paired tags.
<!-- begin voy_header --><!-- end voy_header --> used for definitions such as the cascading style sheet and hyperlink options.
<!-- begin voy_structure --><!-- end voy_structure --> used for defining the exact location where generated table of contents text is to be placed. You can place hyperlinks to other navigation control outside of these two comment tags. An example of that would be fake-buttons to the files associated with the letters of the alphabet.
Note: The tag names in the comment can be changed. However, the change needs to be propagated into global.pm, mif2htm.ini, the voyant_master.html files, and the main header files used by Doxygen (voyant_head.txt and voyant_foot.txt).
|
|
|
Open-Source tools compliments of Voyant Technologies, Inc. and Glenn C. Maxey.
01/13/2003
TP Tools v2-00-0a
# tpt-hug-02